List projects
Returns projects, newest first, by cursor. Nothing confidential is ever here, whatever the key holds.
Scope: projects:read
AuthorizationBearer <token>Send Authorization: Bearer <token> on every request. The token is one of:
| Prefix | What it is | Where it may be used |
|---|---|---|
agoo_sk_live_ | Secret key, live mode | Your servers only |
agoo_sk_test_ | Secret key, test mode | Your servers only |
agoo_pk_live_ | Publishable key, live mode | Browsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people. |
agoo_pk_test_ | Publishable key, test mode | As above, in test mode |
agoo_rk_live_ | Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews Business | Your servers only: the Reviews operations, for that business and the branches the key names |
agoo_rk_test_ | Agoo Reviews key, test mode | As above, on any level: it reads the business's reviews and checks every write without saving it |
agoo_ck_live_ | Check API key, live mode, for a Check API partner | Your servers only: the Checks operations (checks:read), billed per check |
agoo_ck_test_ | Check API key, test mode | As above, answering only the published test values, never billed |
Admins create keys in Console → Developers → API keys and choose each key's scopes; a business on Agoo Reviews on its own creates its keys in its business area on agoo.reviews, under Developers; a Check API partner creates its keys in its partner area on agoo.reviews. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.
Scope: projects:read
limit?integerHow many, up to 200.
1 <= value <= 20050cursor?stringWhere the next page starts.
^proj_[0-7][0-9a-hjkmnp-tv-z]{25}$view?stringWhich part of the lifecycle. Open by default.
"open""closed""archived""all"state?stringOnly projects in this state.
"proposed""approved""active""on_hold""completed""cancelled""archived"q?stringWords in the name.
A page of projects.
application/json- response
data*array<>next_cursor*|Pass this as cursor to get the next page. null on the last page.
"b3BhcXVlLWN1cnNvcg"has_more*booleancurl -X GET 'https://api.agoohq.com/v1/projects'{ "data": [ { "id": "string", "container_id": "string", "name": "string", "description": "string", "visibility": "members", "state": "proposed", "state_reason": "string", "owner": {}, "sponsor": {}, "client": {}, "start_on": "2019-08-24", "target_on": "2019-08-24", "closed_on": "2019-08-24", "latest_update": {}, "signals": {}, "open_tasks": 0, "limit_reached": true, "version": 0, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "next_cursor": "b3BhcXVlLWN1cnNvcg", "has_more": true}Update a company PATCH
Names the version it read. **Scope:** `contacts:write`
Create a project POST
Creates a project with its own task list and an owner the key names. It starts proposed unless you say active; at the limit of the plan it stays proposed and says `limit_reached`. Fires `project.created`. **Scope:** `projects:write`