Skip to main content
GET
Get a task

Authorizations

Authorization
string
header
required

A Parley API key.

Path Parameters

id
string
required

The task ID.

Minimum string length: 1

Response

OK

id
string
required

The task ID.

Minimum string length: 1
title
string
required

Task title.

Required string length: 1 - 500
status
enum<string> | null
required

Where the task stands: todo, in_progress, done, or cancelled, or null when it has no status. done and cancelled close it.

Available options:
todo,
in_progress,
done,
cancelled
assignee
object | null
required

The person the task is assigned to, or null.

dueDate
string<date> | null
required

The day the task is due, as YYYY-MM-DD, or null.

description
string | null
required

Details, or null.

linkedRecord
object | null
required

The project, account, or contact the task is about, or null.

reminder
object | null
required

Your reminder for the task, or null. Reminders are personal: each person sees only their own.

createdAt
string<date-time>
required

When the task was created.

updatedAt
string<date-time>
required

When the task was last renamed or linked to a different record. Changes to its status, assignee, due date, description, field values, and reminders do not change it.

fields
object
required

Custom field values, keyed by field name, with a key for every field defined for tasks (null when unset). The value's shape follows the field's type. Status, assignee, due date, and description are properties of the task, not fields.