CYcyberdesk-hq
runs

List Runs

List all runs for the authenticated organization.

Supports pagination and filtering by workflow, machine, and status. Returns runs with their associated workflow and machine data.

Use the include parameter to fetch related resources in the response. Related resources are returned in the included array following the JSON:API pattern. Resources are deduplicated across all items in the list.

get/v1/runs

Request

  • Base URL
    https://api.cyberdesk.io
  • URL
    https://api.cyberdesk.io/v1/runs
  • Auth
    HTTP bearer

Query parameters

workflow_idstring uuid nullable

Filter by workflow ID

machine_idstring uuid nullable

Filter by machine ID

session_idstring uuid nullable

Filter by session ID

status'scheduling' | 'running' | 'running_checks' | 'success' | 'cancelled' | 'task_failed' | 'error'

Filter by run status

created_at_fromstring date-time nullable

Filter runs created at or after this ISO timestamp (UTC)

created_at_tostring date-time nullable

Filter runs created at or before this ISO timestamp (UTC)

sort_mode'activity' | 'created_at_desc'

Run sort mode. 'activity' prioritizes running/scheduling and recent completions. 'created_at_desc' returns strict reverse-chronological order.

searchstring nullable

Search runs by id, input_values, output_data, error, session_alias (case-insensitive substring match)

deep_searchboolean

If true, also search run_message_history (slower but more comprehensive)

fieldsRunField[] nullable

Optional list of fields to include per run. Always includes: id, workflow_id, machine_id, status, created_at. Provide multiple 'fields=' params to include more.

includestring nullable

Comma-separated list of related resources to include. Allowed values: workflow, machine, machine.pools. Example: include=workflow,machine

skipinteger
limitinteger

Response

Successful Response

totalinteger required
skipinteger required
limitinteger required

Changes

No recorded changes to this operation across all 2 revisions of this API.