List schedules

GET

/v1/schedules

GET

/v1/schedules

$ curl https://api.runtype.com/v1/schedules \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json"

1 {
2   "data": [
3     {
4       "agentId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
5       "createdAt": "2024-06-10T09:15:00Z",
6       "cron": "0 8 * * 1-5",
7       "enabled": true,
8       "executionOptions": {
9         "retryOnFailure": true,
10         "maxRetries": 3
11       },
12       "flowId": "f1234567-89ab-4cde-f012-3456789abcde",
13       "id": "s9876543-21fe-dcba-0987-654321fedcba",
14       "inputs": {
15         "param1": "value1",
16         "param2": 42
17       },
18       "lastRunAt": "2024-06-09T08:00:00Z",
19       "name": "Daily Data Sync",
20       "nextRunAt": "2024-06-10T08:00:00Z",
21       "organizationId": "org-1234567890abcdef",
22       "productSurfaceId": "prod-0987654321fedcba",
23       "recordIds": [
24         "rec-0011223344556677"
25       ],
26       "recordType": "database-record",
27       "runAt": "2024-06-10T08:00:00Z",
28       "timezone": "America/New_York",
29       "triggerType": "cron",
30       "updatedAt": "2024-06-10T09:00:00Z",
31       "userId": "user-abcdef1234567890"
32     }
33   ],
34   "pagination": {
35     "currentOffset": 0,
36     "hasMore": true,
37     "hasPrev": false,
38     "limit": 50,
39     "nextCursor": "cursor_abc123",
40     "prevCursor": null,
41     "currentPage": 1,
42     "totalCount": 120,
43     "totalPages": 3
44   }
45 }

Returns a paginated list of schedules for the authenticated user.

Authentication

AuthorizationBearer

API key or Clerk session token

Query parameters

limitstringOptional

Max results per page (default 50, max 100)

cursorstringOptional

Pagination cursor

searchstringOptional

Search by name

statusenumOptional

Filter by status

Allowed values:

Response

List of schedules

datalist of objects

paginationobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error