Docs

Get a task

Preview· P9
GET
/tasks/{task_id}

Returns one task. One the key can't see doesn't exist for it.

Scope: tasks:read

Authorization

headerAuthorizationBearer <token>

Send Authorization: Bearer <token> on every request. The token is one of:

PrefixWhat it isWhere it may be used
agoo_sk_live_Secret key, live modeYour servers only
agoo_sk_test_Secret key, test modeYour servers only
agoo_pk_live_Publishable key, live modeBrowsers 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 modeAs above, in test mode
agoo_rk_live_Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews BusinessYour servers only: the Reviews operations, for that business and the branches the key names
agoo_rk_test_Agoo Reviews key, test modeAs 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 partnerYour servers only: the Checks operations (checks:read), billed per check
agoo_ck_test_Check API key, test modeAs 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

Path Parameters

task_id*string
Match^task_[0-7][0-9a-hjkmnp-tv-z]{25}$

Response Body

The task.

application/json
  1. 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
Match^task_[0-7][0-9a-hjkmnp-tv-z]{25}$
ref_no?integer
Formatint64
title*string
description?string
acceptance?string
kind?string
Value in"task""approval""acknowledgement""checklist_item"
parent_id?string
container?

The list it lives in: id, name, kind, visibility and workflow_id.

owner?

Whoever is accountable: id and name. Absent in triage.

priority?string
Value in"urgent""high""medium""low"
status?

id, name (the organisation's own) and category (backlog, ready, in_progress, blocked, in_review, completed, cancelled).

start_on?string
Formatdate
due_on?string
Formatdate
due_at?string
Formatdate-time
due_tz?string
tags?array<string>
source?

Where it came from, if anywhere.

completion_outcome?string
Value in"done""skipped""blocked""override""source_confirmed""cancelled"
series_id?string

The repeating task it's one occurrence of.

occurrence_key?string

Its identity in that series: the date in the series' time zone, or the task before it for one that repeats on completion.

version*integer

Name this when you change it.

Formatint64
created_at?string
Formatdate-time
updated_at?string
Formatdate-time
curl -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"}