Tasks

Get a task by ID

Fetches a single task with related card/board context and resolved attachment metadata. When includeMetadata=true, also returns display labels (priorityLabel, statusLabel) and the resolved assignee.

get/api/tasks/{taskId}

Request

Base URL
https://core-api.getaptly.com
Auth
- API key in header x-token
- or API key in header Authorization
TypeScript
https://skmtc.dev/getaptly/apis/aptly-api/docs/api/tasks/:taskId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

taskIdstring required

Query parameters

includeMetadataboolean

Include display labels and the resolved assignee.

Response

The task.

_idstring

companyIdstring

titlestring

mergedTitlestring

Title with {{ }} merge tags resolved against the task's representative contact, the company, and the acting user.

descriptionstring

mergedDescriptionstring

Description with {{ }} merge tags resolved (HTML output).

userIdstring

Assigned user id.

checkedboolean

archivedboolean

statusstring

prioritystring

dueAtstring date-time

aptletInstanceIdstring

aptletUuidstring

priorityLabelstring

Present only when includeMetadata=true.

statusLabelstring