GET
/
schedules
Get scheduled runs
curl --request GET \
  --url https://api.captaindata.com/v4/schedules \
  --header 'X-API-Key: <api-key>'
[
  {
    "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "action_id": 123,
    "action_name": "<string>",
    "user_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "ACTIVE",
    "postponed_until": "2023-11-07T05:31:56Z",
    "cron": "<string>",
    "timezone": "<string>",
    "next_execution_at": "2023-11-07T05:31:56Z",
    "last_executed_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
uid
string<uuid>[] | null

Scheduled run status

Minimum length: 1
​
status
enum<string>[] | null

Scheduled run status

Minimum length: 1
​
user_uid
string<uuid>[] | null

User UUID

Minimum length: 1
​
workspace_uid
string<uuid>[] | null

Workspace UUID

Minimum length: 1
​
action_name
string[] | null

Action name

Minimum length: 1
​
next_execution_at
string<date-time>[] | null

Next execution at

Minimum length: 1
​
last_executed_at
string<date-time>[] | null

Last executed at

Minimum length: 1
​
created_at
string<date-time>[] | null

Created at

Minimum length: 1
​
updated_at
string<date-time>[] | null

Updated at

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 scheduled runs