Skip to navigation
API ReferenceTasks

List tasks

Beta

The tasks of a workspace the caller belongs to that they can open, soonest due first (tasks with no due date last, newest first). Open tasks unless status says otherwise. Filter by assignee (me for the caller’s own), due dates (calendar days, inclusive), a label’s name or a record the task links. A listed task carries no links and a null can_edit: read one task for them.

Authentication

X-API-KEYstring
API Key authentication via header

Headers

X-Athena-Session-CredentialstringOptional

Query parameters

workspace_idstringRequired

The workspace to list; the caller must be a member.

assignee_refstring or nullOptional

Only tasks assigned to this user_… or agent_asset_…, or me.

statusenumOptionalDefaults to open

open (the default), done or all.

Allowed values:
due_on_or_beforestring or nullOptional

YYYY-MM-DD: only tasks due on or before this day.

due_on_or_afterstring or nullOptional

YYYY-MM-DD: only tasks due on or after this day.

labelstring or nullOptional
Only tasks with a label of exactly this name.
linked_idstring or nullOptional
Only tasks that link this asset or ontology object id.
limitintegerOptional1-200Defaults to 200
At most this many tasks.

Response

The tasks.
itemslist of objects

At most limit tasks; each carries no links and a null can_edit.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error