GET
/
runs
Get runs
curl --request GET \
  --url https://api.captaindata.com/v4/runs \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": 123,
    "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "action_id": 123,
    "action_name": "<string>",
    "retry_count": 0,
    "user_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "execution_mode": "LIVE",
    "last_error": {
      "label": "<string>",
      "message": "<string>"
    },
    "callback": {
      "url": "<string>"
    },
    "status": "<string>",
    "postponed_until": "2023-11-07T05:31:56Z",
    "started_at": "<string>",
    "finished_at": "<string>",
    "synced_at": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  }
]
uid is used for all the endpoints and Run manipulation.The id is an internal identifier returned to smooth and improve speed and accuracy if you have questions about your runs you will want to submit to the team.

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
status
string[] | null
Minimum length: 1
​
action_name
string[] | null
Minimum length: 1
​
execution_mode
enum<string>[] | null
Minimum length: 1
​
uid
string<uuid>[] | null
Minimum length: 1
​
user_uid
string<uuid>[] | null
Minimum length: 1
​
workspace_uid
string<uuid>[] | null
Minimum length: 1
​
limit
integer
default:10
Required range: 1 <= x <= 100
​
offset
integer
default:0
Required range: x >= 0
​
sort
string[]

Sort by fields. Prefix with - for descending order. Default is ascending order.

Maximum length: 10

Response

200
application/json

Returns the runs