Skip to main content
GET
Get one of your asks and its outcome
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

Reads one ask you made with Ask a person. Name it by exactly one of ?humanTaskId= and ?clientReference=. Both or neither is 400 bad_request with error.reason: "invalid_body". This is how you read the answer. The human_task.completed and human_task.canceled webhooks carry ids only, and a platform key has no webhook path of its own, so a platform key polls this read. An app whose human_tasks:use grant is only at a sub-unit hears no webhook either; it polls this read too, which works while its grant covers the task’s home.

What it returns

Each closed-only field is null while the ask is open. An ask that was closed superseded because your app or key could no longer ask (it was deactivated or revoked, or its grant no longer covers the task’s home) sent no webhook, so read it here.

Answers

Example

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

humanTaskId
string

The task's id, as requestHumanTask returned it.

Minimum string length: 1
clientReference
string

Your own reference for the ask.

Minimum string length: 1

Response

The ask

data
object
required

One of your asks and its outcome. Once completed: the action taken (actionTaken, one of your action ids), the form's output, the person's own reason and who answered (completedBy.personId). Once canceled: cancelReason (due_date, declined when everyone asked declined, withdrawn, or superseded when you could no longer ask). Once you withdrew it: the reason you gave (withdrawReason). Each part is null until it exists; a decline's reason is never returned.

meta
object
required