Skip to content
Squally Docs

List runs

GET
/projects/{projectId}/runs
curl --request GET \
  --url 'https://app.squally.dev/api/v1/projects/example/runs?days=7&status=passed&perPage=10&direction=next' \
  --header 'Authorization: Bearer <token>'

Runs in a period, newest first - one row per logical run (a sharded CI run is one row). Filter by branch, commit SHA prefix or outcome; page with the cursors. Cheap to moderate: one bounded scan.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
projectId
required
string

A project id from GET /projects.

Query Parameters

Section titled “Query Parameters”
days
integer
default: 30
Allowed values: 7 30 90

The period, in days, ending now. Must not exceed the plan’s retention (Standard 60, Pro 90 days); a longer period is refused with 400 invalid_period rather than answered with less data.

branch
string
>= 1 characters <= 200 characters

Exact branch name.

sha
string
/^[0-9a-fA-F]{4,40}$/

A commit SHA or a prefix of one (4-40 hex characters). Matches the run’s commit or its tested revision (a pull request’s head behind a merge commit).

status
string
Allowed values: passed failed

Only runs with this outcome.

perPage
integer
default: 10
Allowed values: 10 25 50

Rows per page.

cursor
string
/^[0-9A-Za-z_-]{1,64}$/

Opaque. Pass nextCursor for older runs, or prevCursor together with direction=prev for newer runs.

direction
string
default: next
Allowed values: next prev

Which way the cursor pages.

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
project
required
object
id
required
string
name
required
string
window
required
object
days
required
integer
>= -9007199254740991 <= 9007199254740991
from
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
to
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
stableBranch
required
string
runs
required
Array<object>
object
id
required
string
runNumber
required
integer
>= -9007199254740991 <= 9007199254740991
branch
required
Any of:
string
commitSha
required
Any of:
string
testedRevision
required
Any of:
string
pullRequestNumber
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
status
required
Any of:
string
startedAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
finishedAt
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
durationMs
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
counts
required
object
total
required
integer
>= -9007199254740991 <= 9007199254740991
passed
required
integer
>= -9007199254740991 <= 9007199254740991
failed
required
integer
>= -9007199254740991 <= 9007199254740991
skipped
required
integer
>= -9007199254740991 <= 9007199254740991
recovered
required
integer
>= -9007199254740991 <= 9007199254740991
shards
required
Any of:
object
received
required
integer
>= -9007199254740991 <= 9007199254740991
expected
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
total
required
integer
>= -9007199254740991 <= 9007199254740991
nextCursor
required
Any of:
string
prevCursor
required
Any of:
string
Examplegenerated
{
  "project": {
    "id": "example",
    "name": "example"
  },
  "window": {
    "days": 1,
    "from": "2026-04-15T12:00:00Z",
    "to": "2026-04-15T12:00:00Z"
  },
  "stableBranch": "example",
  "runs": [
    {
      "id": "example",
      "runNumber": 1,
      "branch": "example",
      "commitSha": "example",
      "testedRevision": "example",
      "pullRequestNumber": 1,
      "status": "example",
      "startedAt": "2026-04-15T12:00:00Z",
      "finishedAt": "2026-04-15T12:00:00Z",
      "durationMs": 1,
      "counts": {
        "total": 1,
        "passed": 1,
        "failed": 1,
        "skipped": 1,
        "recovered": 1
      },
      "shards": {
        "received": 1,
        "expected": 1
      }
    }
  ],
  "total": 1,
  "nextCursor": "example",
  "prevCursor": "example"
}

Headers

Section titled “Headers”
Squally-Key-Expires-At
string format: date-time

When the read key expires (ISO-8601). Present only from 7 days before expiry.

400

Section titled “400”

Error: invalid_parameter, invalid_period

Media typeapplication/json
object
error
required

A sentence for a human. May be reworded.

string
code
required

Stable slug - match on this, not on the sentence.

string
Allowed values: missing_key invalid_key wrong_key_type key_revoked key_expired tier_too_low project_not_found invalid_period rate_limited test_not_found ambiguous_test internal_error invalid_parameter run_not_found error_not_found
code
required
Allowed values: invalid_parameter invalid_period
Example
{
  "code": "invalid_parameter"
}

401

Section titled “401”

Error: invalid_key, key_expired, key_revoked, missing_key, wrong_key_type

Media typeapplication/json
object
error
required

A sentence for a human. May be reworded.

string
code
required

Stable slug - match on this, not on the sentence.

string
Allowed values: missing_key invalid_key wrong_key_type key_revoked key_expired tier_too_low project_not_found invalid_period rate_limited test_not_found ambiguous_test internal_error invalid_parameter run_not_found error_not_found
code
required
Allowed values: invalid_key key_expired key_revoked missing_key wrong_key_type
Example
{
  "code": "invalid_key"
}

403

Section titled “403”

Error: tier_too_low

Media typeapplication/json
object
error
required

A sentence for a human. May be reworded.

string
code
required

Stable slug - match on this, not on the sentence.

string
Allowed values: missing_key invalid_key wrong_key_type key_revoked key_expired tier_too_low project_not_found invalid_period rate_limited test_not_found ambiguous_test internal_error invalid_parameter run_not_found error_not_found
code
required
Allowed values: tier_too_low
Example
{
  "code": "tier_too_low"
}

404

Section titled “404”

Error: project_not_found

Media typeapplication/json
object
error
required

A sentence for a human. May be reworded.

string
code
required

Stable slug - match on this, not on the sentence.

string
Allowed values: missing_key invalid_key wrong_key_type key_revoked key_expired tier_too_low project_not_found invalid_period rate_limited test_not_found ambiguous_test internal_error invalid_parameter run_not_found error_not_found
code
required
Allowed values: project_not_found
Example
{
  "code": "project_not_found"
}

429

Section titled “429”

Rate limited by the edge firewall. No JSON body and no Retry-After - back off for at least 60 s.

500

Section titled “500”

Error: internal_error

Media typeapplication/json
object
error
required

A sentence for a human. May be reworded.

string
code
required

Stable slug - match on this, not on the sentence.

string
Allowed values: missing_key invalid_key wrong_key_type key_revoked key_expired tier_too_low project_not_found invalid_period rate_limited test_not_found ambiguous_test internal_error invalid_parameter run_not_found error_not_found
code
required
Allowed values: internal_error
Example
{
  "code": "internal_error"
}