Skip to content
Squally Docs

Get a run with all its tests

GET
/projects/{projectId}/runs/{runId}
curl --request GET \
  --url https://app.squally.dev/api/v1/projects/example/runs/example \
  --header 'Authorization: Bearer <token>'

One logical run and every test’s final attempt. Any shard’s id works: a sharded run is answered for all its shards, each test naming the shard that ran it. Moderate: reads every result of the run.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
projectId
required
string

A project id from GET /projects.

runId
required
string

A run id from GET /projects/{projectId}/runs - or any shard’s id of a sharded run.

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
project
required
object
id
required
string
name
required
string
run
required
object
id
required
string
runNumber
required
integer
>= -9007199254740991 <= 9007199254740991
branch
required
Any of:
string
commitSha
required
Any of:
string
commitMessage
required
Any of:
string
authorName
required
Any of:
string
testedRevision
required
Any of:
string
pullRequestNumber
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
pullRequestTitle
required
Any of:
string
ciProvider
required
Any of:
string
status
required
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
shards
required
Any of:
object
expected
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
received
required
Array<object>
object
runId
required
string
index
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
runState
required
string
status
required
Any of:
string
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
tests
required
Array<object>
object
testName
required
string
filePath
required
Any of:
string
status
required
string
attempts
required
integer
>= -9007199254740991 <= 9007199254740991
durationMs
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
errorMessage
required
Any of:
string
fingerprint
required
Any of:
string
browserName
required
Any of:
string
shard
required
Any of:
object
index
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
runId
required
string
Examplegenerated
{
  "project": {
    "id": "example",
    "name": "example"
  },
  "run": {
    "id": "example",
    "runNumber": 1,
    "branch": "example",
    "commitSha": "example",
    "commitMessage": "example",
    "authorName": "example",
    "testedRevision": "example",
    "pullRequestNumber": 1,
    "pullRequestTitle": "example",
    "ciProvider": "example",
    "status": "example",
    "startedAt": "2026-04-15T12:00:00Z",
    "finishedAt": "2026-04-15T12:00:00Z",
    "durationMs": 1,
    "shards": {
      "expected": 1,
      "received": [
        {
          "runId": "example",
          "index": 1,
          "runState": "example",
          "status": "example"
        }
      ]
    }
  },
  "counts": {
    "total": 1,
    "passed": 1,
    "failed": 1,
    "skipped": 1,
    "recovered": 1
  },
  "tests": [
    {
      "testName": "example",
      "filePath": "example",
      "status": "example",
      "attempts": 1,
      "durationMs": 1,
      "errorMessage": "example",
      "fingerprint": "example",
      "browserName": "example",
      "shard": {
        "index": 1,
        "runId": "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.

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, run_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 run_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"
}