Skip to main content
GET
Get a task by ID

Authorizations

x-token
string
header
required

Path Parameters

taskId
string
required

Query Parameters

includeMetadata
boolean

Include display labels and the resolved assignee.

Response

The task.

_id
string
companyId
string
title
string
mergedTitle
string

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

description
string
mergedDescription
string

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

userId
string

Assigned user id.

checked
boolean
archived
boolean
status
string
priority
string
dueAt
string<date-time>
aptletInstanceId
string
aptletUuid
string
attachments
object[]
priorityLabel
string

Present only when includeMetadata=true.

statusLabel
string

Present only when includeMetadata=true.

assignee
object

Present only when includeMetadata=true.