Skip to main content
GET
List scheduling tasks
Beta: this endpoint may change or be removed without notice while in beta. There is no compatibility promise until it reaches general availability.

Authorizations

Authorization
string
header
required

API tokens are passed as Bearer tokens.

Query Parameters

cursor
string

Opaque pagination cursor from the previous page's pagination.next_cursor, bound to the same query filters.

limit
integer
default:25

Page size. Must be between 1 and 100; defaults to 25.

Required range: 1 <= x <= 100
ids
string[] | null

Comma-separated list of IDs; maximum 100 values.

a task ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Pattern: ^(?:tsk_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
assignee_ids
string[] | null

Matches tasks assigned to any listed employee; combines with other filters using AND.

an employee ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Pattern: ^(?:emp_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
statuses
enum<string>[] | null

Matches tasks with any listed status; combines with other filters using AND.

Available options:
NEEDS_AVAILABILITY,
WAITING_FOR_CANDIDATE,
READY_TO_SCHEDULE,
READY_TO_RESCHEDULE,
HOLD,
READY_TO_SEND_TO_CANDIDATE,
SCHEDULED,
COMPLETED,
CANCELED,
NEEDS_DEBRIEF
is_urgent
boolean

Matches the task urgency flag; combines with other filters using AND.

queue_ids
string[] | null

Matches tasks in any listed queue; combines with other filters using AND.

a task queue ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Pattern: ^(?:que_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
flagged
boolean

When true, returns tasks with at least one flag; when false, returns tasks with no flags. Combines with other filters using AND.

tags
string[] | null

Matches tasks carrying any listed tag; combines with other filters using AND.

delegate_statuses
enum<string>[] | null

Matches tasks with any listed delegation status; combines with other filters using AND.

Available options:
NONE,
QUEUED,
ACTIVE,
WAITING_ON_CANDIDATE,
WAITING_ON_TEAM,
COMPLETED,
STOPPED
job_ids
string[] | null

Matches tasks for applications on any listed job; combines with other filters using AND.

a job ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Pattern: ^(?:job_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
application_ids
string[] | null

Matches tasks for any listed application; combines with other filters using AND.

an application ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Pattern: ^(?:app_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
created_at_gte
string<date-time>

Filters records created at or after this timestamp.

created_at_lte
string<date-time>

Filters records created at or before this timestamp.

updated_at_gte
string<date-time>

Filters records updated at or after this timestamp.

updated_at_lte
string<date-time>

Filters records updated at or before this timestamp.

Response

Success

data
object[]
required
pagination
object
required