Get a task
Returns one task. One the key can't see doesn't exist for it.
Scope: tasks: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: tasks:read
task_id*string^task_[0-7][0-9a-hjkmnp-tv-z]{25}$The task.
application/json- response
A task. A date is a day or an instant, never one pretending to be the other, and its state is a category with no ambiguous done flag.
id*TaskId^task_[0-7][0-9a-hjkmnp-tv-z]{25}$ref_no?integerint64title*stringdescription?stringacceptance?stringkind?string"task""approval""acknowledgement""checklist_item"parent_id?stringcontainer?The list it lives in: id, name, kind, visibility and workflow_id.
owner?Whoever is accountable: id and name. Absent in triage.
priority?string"urgent""high""medium""low"status?id, name (the organisation's own) and category (backlog, ready, in_progress, blocked, in_review, completed, cancelled).
start_on?stringdatedue_on?stringdatedue_at?stringdate-timedue_tz?stringtags?array<string>source?Where it came from, if anywhere.
completion_outcome?string"done""skipped""blocked""override""source_confirmed""cancelled"series_id?stringThe repeating task it's one occurrence of.
occurrence_key?stringIts identity in that series: the date in the series' time zone, or the task before it for one that repeats on completion.
version*integerName this when you change it.
int64created_at?stringdate-timeupdated_at?stringdate-timecurl -X GET 'https://api.agoohq.com/v1/tasks/string'{ "id": "string", "ref_no": 0, "title": "string", "description": "string", "acceptance": "string", "kind": "task", "parent_id": "string", "container": {}, "owner": {}, "priority": "urgent", "status": {}, "start_on": "2019-08-24", "due_on": "2019-08-24", "due_at": "2019-08-24T14:15:22Z", "due_tz": "string", "tags": [ "string" ], "source": {}, "completion_outcome": "done", "series_id": "string", "occurrence_key": "string", "version": 0, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}Create a task POST
Creates a task in a shared list: a key has to name one. Fires `task.created`, and `task.assigned` when it has an owner. Sending `client_id` again finds the same task. A date-only `due_on` is a calendar day and is never turned into an instant. **Scope:** `tasks:write`
Update a task PATCH
Changes a task. Name the version you read: a stale one is `version_stale` (409), and nothing changes. A date given as an empty string clears it. **Scope:** `tasks:write`