Skip to main content
GET
List runs
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Accept
enum<string>
default:application/json
required

Specifies the expected response format. Must be set to application/json for proper API communication.

Available options:
application/json

Path Parameters

project_id
string
required

Id of the project. You can get project_id by listing your projects using the List projects API.

Example:

"pdqmxlz"

Query Parameters

branch
string

Filter runs by branch name.

Example:

"main"

status
enum<string>

Filter runs by status. Current status of the run.

Available options:
running,
passed,
failed,
passing,
failing,
timedOut,
interrupted
Example:

"passed"

page_number
integer
default:1

Page of results to retrieve, starting from 1. Defaults to 1 when omitted.

Example:

1

page_size
integer

Number of records returned per page. Each endpoint applies its own default and maximum value.

Example:

15

Response

200 - application/json

OK - Request succeeded. Defaults to 15 runs per page (maximum 50).

runs
object[]
pagination
object