List runs

Lists runs, newest activity first, 20 per page by default. Narrow it with one of realm_id, daemon_id, workspace_id, parent_run_id (sub-runs of a run), team_id or team; without any of them, org_id is required and the list covers that organization’s realms. Results never include runs in realms you cannot see.

Requires a signed-in user token; with realm_id, a realm member (or higher) with the runs.view permission on that realm; with org_id, a role with the runs.view permission in that organization. With neither, the results are limited to what you can see.

POST

runs

get

curl --request POST \
  --url https://{host}/v1/runs/get \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b",
  "state": [
    "failed",
    "crashed"
  ],
  "limit": 10
}
'

{
  "ok": true,
  "data": {
    "items": [
      {
        "run_id": "0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f",
        "workspace_id": "9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f",
        "team_id": "3f6c2a8e-6b1d-4c1e-9a57-0d2f4b8e91c4",
        "daemon_id": "7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
        "realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b",
        "realm_slug": "production",
        "org_slug": "acme",
        "parent_run_id": null,
        "parent_phase": null,
        "root_run_id": null,
        "call_path": null,
        "call_depth": 0,
        "iteration_key": null,
        "run_name": "brave-otter",
        "state": "failed",
        "inputs": {
          "pr_url": "https://github.com/acme/api/pull/42"
        },
        "error": "phase fix: tests failed",
        "execution_type": "local",
        "current_pid": null,
        "current_phase": null,
        "external_id": null,
        "context_labels": null,
        "lease_expires_at": null,
        "started_at": 1759834200000,
        "completed_at": 1759834700000,
        "team_label": "@acme/code-review",
        "workspace_name": "acme-api",
        "last_updated_at": 1759834700000
      }
    ],
    "total": 1,
    "offset": 0,
    "limit": 10,
    "type": "array"
  }
}

{
  "ok": false,
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  }
}

{
  "ok": false,
  "error": {
    "code": "forbidden",
    "message": "You do not have access to do this"
  }
}

{
  "ok": false,
  "error": {
    "code": "not_found",
    "message": "Not found"
  }
}

{
  "ok": false,
  "error": "org_id: org_id is required when listing recent runs without realm_id, daemon_id, workspace_id, parent_run_id, team_id or team",
  "code": "invalid_params"
}

{
  "ok": false,
  "error": "Internal server error",
  "code": "internal_error"
}

Authorizations

Authorization

string

header

required

User PAT (cliq_tok_…, including session-scoped) or realm token (cliq_dt_…).

Body

application/json

workspace_id

string

Only runs in this workspace.

parent_run_id

string

Only the sub-runs a run started (its type team and map phases).

active_only

boolean

Only runs that are running or awaiting_input.

limit

number

Page size. Default 20.

offset

integer

Rows to skip, for paging. Default 0.

daemon_id

string

Only runs on this daemon.

realm_id

string

Only runs whose daemon is in this realm.

team_id

string<uuid>

Restrict to runs of this team (any version). Narrowing filter only — the realm-membership gate still applies. May be sent without org_id: the gate then spans the caller's realms in every org.

team

object

Restrict to runs of this team by name — any install of it on any daemon (uninstalled ones included). Use this for a published team: its id is not the id runs carry. Narrowing only; the realm gate still applies.

Show child attributes

org_id

string<uuid>

Organization whose realms to list. Required when none of realm_id, daemon_id, workspace_id, parent_run_id, team_id or team is sent.

query

string

Matches part of the run id or run name.

state

One state, or a list (for example ["failed", "crashed"]).

Available options:

running,

awaiting_input,

completed,

failed,

cancelled,

crashed

since_ms

number

Only runs started at or after this time (epoch milliseconds).

all

boolean

Site admins only: every record on the hub, not just the caller\

until_ms

number

Only runs started before this time (epoch milliseconds).

sort_by

enum<string>

Column to sort by. Default last_updated_at.

Available options:

run_name,

state,

team,

started_at,

last_updated_at

sort_dir

enum<string>

asc or desc (default).

Available options:

asc,

desc

Response

Success.

enum<boolean>

required

Always true on success.

Available options:

true

data

object

required

Paged RunData list

Show child attributes

curl --request POST \
  --url https://{host}/v1/runs/get \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b",
  "state": [
    "failed",
    "crashed"
  ],
  "limit": 10
}
'

{
  "ok": true,
  "data": {
    "items": [
      {
        "run_id": "0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f",
        "workspace_id": "9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f",
        "team_id": "3f6c2a8e-6b1d-4c1e-9a57-0d2f4b8e91c4",
        "daemon_id": "7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
        "realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b",
        "realm_slug": "production",
        "org_slug": "acme",
        "parent_run_id": null,
        "parent_phase": null,
        "root_run_id": null,
        "call_path": null,
        "call_depth": 0,
        "iteration_key": null,
        "run_name": "brave-otter",
        "state": "failed",
        "inputs": {
          "pr_url": "https://github.com/acme/api/pull/42"
        },
        "error": "phase fix: tests failed",
        "execution_type": "local",
        "current_pid": null,
        "current_phase": null,
        "external_id": null,
        "context_labels": null,
        "lease_expires_at": null,
        "started_at": 1759834200000,
        "completed_at": 1759834700000,
        "team_label": "@acme/code-review",
        "workspace_name": "acme-api",
        "last_updated_at": 1759834700000
      }
    ],
    "total": 1,
    "offset": 0,
    "limit": 10,
    "type": "array"
  }
}

{
  "ok": false,
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  }
}

{
  "ok": false,
  "error": {
    "code": "forbidden",
    "message": "You do not have access to do this"
  }
}

{
  "ok": false,
  "error": {
    "code": "not_found",
    "message": "Not found"
  }
}

{
  "ok": false,
  "error": "org_id: org_id is required when listing recent runs without realm_id, daemon_id, workspace_id, parent_run_id, team_id or team",
  "code": "invalid_params"
}

{
  "ok": false,
  "error": "Internal server error",
  "code": "internal_error"
}

Introduction

System

Auth

Users

Organizations

Invitations

Teams

Realms

Daemons

Workspaces

Runs

Artifacts

Events

Reviews

Notification channels

Notifications

Agents

Settings

Mesh

Jira

A2A

List runs

Authorizations

Body

Response