/tasks

List tasks. Filters combine with AND; status may be repeated to match any of several statuses. Supports pagination. A filtered page can hold fewer tasks than limit and still carry cursors.after; keep paging until it is absent.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
status
array of strings

Return only tasks in any of these statuses. Repeat the parameter for several (status=open&status=completed). Without the parameter, deleted tasks (system tombstones for stops that left their tour) are left out; ask for status=deleted to see them.

status
Allowed:
string
enum

Return only tasks assigned to this scope type. Combine with assigneeId to name the scope; for operator-org the id is implied.

string

The id of the assignee scope named by assigneeType: the user id for user scopes, the team id for team scopes, the carrier/shipper id for org scopes.

string

Return only tasks referencing this entity, by its ORN.

string
^[a-z0-9][a-z0-9-]{1,62}$

Return only tasks created from the task template with this key, as stored on the task at creation. Tasks without a template key are left out.

integer
≥ 0

Epoch seconds, inclusive. Return only tasks closed at or after this time; tasks that are not closed are left out.

boolean

When true, tasks the calling API key has snoozed are included; by default they are left out until the snooze ends. Snoozes by other actors never affect this listing.

string

Pagination cursor from previous response

number

Maximum number of items to return

Responses

400

bad request

401

unauthorized

403

The role of the API key does not allow this action. The key needs a role with the matching permission, for example full access.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json