Skip to main content
List workspace Actions workflow-run projections

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Query Parameters

q
string

Search text, case-insensitive. Matches the workflow name, repository name, branch, a commit SHA prefix, or a run number written as 42 or #42.

Required string length: 1 - 513
Pattern: ^[^\u0000]*$
repository_id
string[]

Repository ID; repeat to select several (OR).

Required array length: 1 - 50 elements
Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_.:-]+$
state
enum<string>[]

Run state, or for an ended run its result status (succeeded, failed, cancelled, skipped, neutral); repeat to select several (OR), for example state=running&state=queued.

Required array length: 1 - 50 elements

A run state, or the result status of an ended run.

Available options:
queued,
preparing,
starting,
running,
stopping,
ended,
attention_required,
succeeded,
failed,
cancelled,
skipped,
neutral
workflow
string[]

Workflow name; repeat to select several (OR). Values come from the facets.

Required array length: 1 - 50 elements
Required string length: 1 - 513
Pattern: ^[^\u0000]*$
branch
string[]

Branch name; repeat to select several (OR).

Required array length: 1 - 50 elements
Required string length: 1 - 513
Pattern: ^[^\u0000]*$
triggered_by
string[]

GitHub login of the triggering actor, bots included (dependabot[bot]); repeat for several (OR).

Required array length: 1 - 50 elements
Required string length: 1 - 513
Pattern: ^[^\u0000]*$
job
string[]

A job selection as unpadded base64url-encoded UTF-8 JSON [workflow, job]; facet labels remain Workflow › job. A run matches when it has any given job. Repeat for several (OR).

Required array length: 1 - 50 elements
Required string length: 1 - 513
Pattern: ^[^\u0000]*$
runner_label
string[]

A requested runner label; a run matches when any job requested any given label. Repeat for several (OR).

Required array length: 1 - 50 elements
Required string length: 1 - 513
Pattern: ^[^\u0000]*$
sort
enum<string>
default:newest

newest (default) or oldest by creation, or longest by duration from first start to end; runs without a duration (active, or end not confirmed) come last. A next_cursor continues the same filters and sort.

Available options:
newest,
oldest,
longest
cursor
string

Opaque cursor from the preceding page; scoped to the original workspace and query.

Required string length: 1 - 128
Pattern: ^[^\u0000]*$
limit
integer
default:20

Maximum number of records to return.

Required range: 1 <= x <= 100

Response

Workspace-owned workflow runs; an empty workspace returns an empty page.

data
object[]
required
next_cursor
string | null
required
Required string length: 1 - 128
Pattern: ^[^\u0000]*$
counts
object

Workspace-wide tab counts, independent of the query's filters.

total
integer

Number of runs matching this query's filters, across all pages.

Required range: x >= 0