/tasks

get

https://api.dev.orbit.do/v5/tasks

List tasks. Filters combine with AND; status may be repeated to match any of several statuses. Supports pagination.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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:

assigneeType

string

enum

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

assigneeId

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.

referencedEntityOrn

string

Return only tasks referencing this entity, by its ORN.

includeSnoozed

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.

cursor

string

Pagination cursor from previous response

limit

number

Maximum number of items to return

Responses

400

bad request

401

unauthorized

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200List of tasks