Runs
Last updated
Was this helpful?
Last updated
Was this helpful?
The runs
namespace provides API methods to retrieve all or specific runs for a project. This page covers the following API methods:
/projects/{project_id}/runs
Returns all runs for a project.
This method uses so you might need to request additional pages to retrieve all runs.
configs
issues
milestones
states
statuses
users
/runs/{run_id}
Returns a single run.
configs
issues
milestones
states
statuses
users
project_id
id
required
ID of the project.
page
integer
Number of page to return (default: first page)
per_page
integer
Maximum number of runs to return (supported: 15
, 25
, 50
, 100
; default: 100
)
sort
string
Sort field for the list of runs (supported: runs:created_at
, runs:closed_at
; default: runs:created_at
)
order
string
Sort order (ascending or descending) (supported: asc
, desc
; default: desc
)
closed_after
string
Limit result to runs closed after (in ISO8601 format and UTC time zone).
closed_before
string
Limit result to runs closed before (in ISO8601 format and UTC time zone).
config_id
string
Comma-separated list of configurations to filter by.
created_after
string
Limit result to runs created after (in ISO8601 format and UTC time zone).
created_before
string
Limit result to runs created before (in ISO8601 format and UTC time zone).
created_by
string
Comma-separated list of users to filter by.
is_closed
boolean
Limit result to active or closed runs only.
milestone_id
string
Comma-separated list of milestones to filter by.
state_id
string
Comma-separated list of workflow states to filter by.
tags
string
Comma-separated list of tags to filter by.
expands
string
Comma-separated list of expands to return.
This method supports the following so you can automatically include additional information for referenced objects:
200
400
401
403
422
()
run_id
id
required
ID of the run to return.
expands
string
Comma-separated list of expands to return.
This method supports the following so you can automatically include additional information for referenced objects:
200
400
401
403
404
422
()