Get a project
Returns one project. One the key can't see doesn't exist for it.
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
project_id*string^proj_[0-7][0-9a-hjkmnp-tv-z]{25}$The project.
application/json- response
A project. Its tasks are ordinary tasks in its list: GET /tasks?container= reads them. What a person reported and what the data says are kept apart.
id*ProjectId^proj_[0-7][0-9a-hjkmnp-tv-z]{25}$container_id*stringThe list its tasks live in.
name*stringdescription?stringvisibility*string"members""org_readable"state*ProjectState"proposed""approved""active""on_hold""completed""cancelled""archived"state_reason?stringowner?Who is accountable: id and name.
sponsor?The sponsor: id and name.
client?The client: kind, id and name.
start_on?stringdatetarget_on?stringdateclosed_on?stringdatelatest_update?What the person responsible last said: id, as_of and health.
signals?What the data says, computed: tasks done, late and blocked, and whether updates are current.
open_tasks?integerint64limit_reached?booleanThe plan's active projects are all in use, so this one stays proposed.
version*integerint64created_at?stringdate-timeupdated_at?stringdate-timecurl -X GET 'https://api.agoohq.com/v1/projects/string'{ "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"}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`
Update a project PATCH
Changes a project. Name the version you read: a stale one is `version_stale` (409), and nothing changes. A date moved here changes the plan, not what was agreed. Fires `project.updated`. **Scope:** `projects:write`