SCscaleapi
Tasks

List Tasks

Changed on

List tasks. Returns a lean summary per task and omits params; fetch GET /tasks/{task_id} for the full record including params.

get/tasks

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

agent_idstring nullable
agent_namestring nullable
status'CANCELED' | 'COMPLETED' | 'FAILED' | 'RUNNING' | 'INTERRUPTED' | 'TERMINATED' | 'TIMED_OUT' | 'DELETED'

Filter tasks by status (e.g. RUNNING, COMPLETED).

task_metadatastring nullable

JSON-encoded object used to filter tasks via JSONB containment. Example: {"created_by_user_id": "abc-123"}.

limitinteger
page_numberinteger
order_bystring nullable
order_directionstring
relationshipsTaskRelationships[]

Response

Successful Response

idstring required
namestring nullable
status'CANCELED' | 'COMPLETED' | 'FAILED' | 'RUNNING' | 'INTERRUPTED' | 'TERMINATED' | 'TIMED_OUT' | 'DELETED'
status_reasonstring nullable
created_atstring date-time nullable
updated_atstring date-time nullable
cleaned_atstring date-time nullable
task_metadataobject nullable

Changes

  • 8f725ddc153eRevision changes
    • warning

      removed the optional property / from the response with the status

  • 702bb2729fe2Revision changes
    • warning

      added the new INTERRUPTED enum value to the // response property for the response status

    • info

      added the enum value INTERRUPTED to the property anyOf[subschema #1: TaskStatus]/ of the query request parameter status