Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-031984301.2 MB
Task

Get Task

Retrieves a task.

get/tasks/{taskId}

Query parameters

fieldsstring

A comma separated list of fields to include in the response. Every value in the list should either consist of a top-level property name (excluding the items envelope for endpoints returning lists) or refer to a property of a top-level property of type object, in the following form: "toplevelpropertyname.subpropertyname". When this query parameter is omitted, default resource representations are returned (excluding fields marked as optional). The same applies to nested objects when just specifying the top-level property name, without explicitly listing sub-property names. When specifying the fields query parameter, only the specified fields are returned. The id property is always returned.

Headers

Authorizationstring required

The bearer access token provided by Auth0.

X-LC-Tenantstring required

The identifier of the account where the request is executed.

Response

idstring required
status'created' | 'inProgress' | 'completed' | 'failed' | 'skipped' | 'canceled' nullable
<div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">The task status.</div>
dueBystring date-time nullable

The task due date. <br> UTC Timezone <br> Allowed formats: <br> "YYYY-MM-DDThh:mmZ" <br> "YYYY-MM-DDThh:mm:ssZ" <br> "YYYY-MM-DDThh:mm:ss.sZ" <br> "YYYY-MM-DDThh:mm:ss.ssZ" <br> "YYYY-MM-DDThh:mm:ss.sssZ"

createdAtstring date-time nullable

The date and time when the task was created. <br> Allowed formats: <br> "YYYY-MM-DDThh:mmZ" <br> "YYYY-MM-DDThh:mm:ssZ" <br> "YYYY-MM-DDThh:mm:ss.sZ" <br> "YYYY-MM-DDThh:mm:ss.ssZ" <br> "YYYY-MM-DDThh:mm:ss.sssZ"

outcomestring

The outcome of the task type. It is retrieved only if the task is completed. It should match one of the legal outcomes in the task type.

commentstring

The comment associated with this task at completion.

completedAtstring date-time nullable

UTC Timezone <br> Allowed formats: <br> "YYYY-MM-DDThh:mmZ" <br> "YYYY-MM-DDThh:mm:ssZ" <br> "YYYY-MM-DDThh:mm:ss.sZ" <br> "YYYY-MM-DDThh:mm:ss.ssZ" <br> "YYYY-MM-DDThh:mm:ss.sssZ"