Skip to main content
GET
List transport runs

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Query Parameters

status
enum<string>

Only runs in this status.

Available options:
planning,
confirmed,
in_progress,
completed,
cancelled
from
string<date>

Runs scheduled on or after this day (YYYY-MM-DD).

to
string<date>

Runs scheduled on or before this day (YYYY-MM-DD).

offset
integer
default:0

How many runs to skip. Anything that is not a whole number of zero or more is read as 0.

Required range: x >= 0
series_id
string

Only the runs of one series. An id that matches nothing returns nothing.

animal_id
string

Only the runs carrying this animal. An id that matches nothing returns nothing.

driver_person_id
string

Only the runs this person drove, the whole run or one of its legs.

Response

The runs.

results
object[]
required
has_more
boolean
required

Whether there are more runs after this page.

limit
integer
required

How many runs a page holds. Always 50.

offset
integer
required

How many were skipped to reach this page.