Runs

List Runs

Retrieve a list of all available Runs.

get/api/v1/runs

Request

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

Query parameters

limitinteger

The maximum number of runs to return.

integer
OR
string date-time

The starting run ID, runStartTime, or runEndTime (exclusive) for paging the query results. A cursor that tells the API where to begin returning results. Use it to continue pagination from a specific point in the dataset. This value must come from the next field in the previous response. If you define a query cursor using startingFrom, you must also include the orderBy parameter.

orderBy'id' | 'runStartTime' | 'runEndTime'

The field used to sort query results.

The field used to order results.

orderByDirection'asc' | 'desc'

The sort order for query results.

string
OR
string[]

One or more project IDs to filter the query results.

'deploy' | 'refresh'
OR
RunType[]

One or more run types to filter the query results. Pass a single value or multiple values (repeated query parameters or an array). When passing multiple values, up to 10 per request.

'canceled' | 'completed' | 'failed' | 'initializing' | 'rendering' | 'running' | 'waitingToRun'
OR
RunStatus[]

One or more status values to filter the query results. Pass a single value or multiple values (repeated query parameters or an array). When passing multiple values, up to 10 per request.

string
OR
string[]

One or more environment IDs to filter the query results. Pass a single value or multiple values (repeated query parameters or an array). When passing multiple values, up to 10 per request.

detailboolean

Include the full detail of the run.

Response

A collection of runs.

limitinteger required

Limit of the records returned. Some endpoints have limit as a query parameter.

orderByDirection'asc' | 'desc' required

The sort order for query results.

orderBystring required

The field to order the results by. Only id allowed.

Changes

No recorded changes to this operation across all 1 revision of this API.