Tasks

Get a task

Get a single task by ID, with its field values and the caller's own reminder for it.

get/tasks/{id}

Request

  • Base URL
    https://api.parley.so/v1
  • URL
    https://api.parley.so/v1/tasks/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The task ID.

Response

OK

idstring required

The task ID.

titlestring required

Task title.

status'todo' | 'in_progress' | 'done' | 'cancelled' nullable required

Where the task stands: todo, in_progress, done, or cancelled. done and cancelled close it.

dueDatestring date nullable required

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

descriptionstring nullable required

Details, or null.

createdAtstring date-time required

When the task was created.

updatedAtstring 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.

fieldsobject 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.

Changes

No recorded changes to this operation across all 2 revisions of this API.