Skip to main content
GET
List tasks

Authorizations

Authorization
string
header
required

A Parley API key.

Query Parameters

Case-insensitive. Every word must match the title or a text custom field.

Minimum string length: 1
statuses
enum<string>[]

Only tasks whose status is one of these.

Minimum array length: 1

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

Available options:
todo,
in_progress,
done,
cancelled
assigneeId
string

Only tasks assigned to the user with this ID.

Minimum string length: 1
dueSince
string<date>

Only tasks due on or after this day, as YYYY-MM-DD.

dueBefore
string<date>

Only tasks due before this day, as YYYY-MM-DD.

projectId
string

Only tasks about this project.

Minimum string length: 1
accountId
string

Only tasks about this account.

Minimum string length: 1
contactId
string

Only tasks about this contact.

Minimum string length: 1
createdSince
string

Only records created at or after this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

createdBefore
string

Only records created before this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

updatedSince
string

Only records last updated at or after this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

updatedBefore
string

Only records last updated before this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

sort
enum<string>
default:-createdAt

Sort order: a field name, prefixed with - for descending. Defaults to -createdAt.

Available options:
title,
-title,
createdAt,
-createdAt,
updatedAt,
-updatedAt
cursor
string

Opaque cursor from nextCursor. Pass the same filters and sort. Omit for the first page.

Minimum string length: 1
limit
integer
default:50

Maximum number of items to return.

Required range: 1 <= x <= 250

Response

OK

data
object[]
required
nextCursor
string | null
required

Cursor for the next page, or null on the last page.