List schedules for surface

GET

/v1/products/:id/surfaces/:surfaceId/schedules

GET

/v1/products/:id/surfaces/:surfaceId/schedules

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

1 {
2   "data": [
3     {
4       "agentId": "agent_9f8b7c6d",
5       "createdAt": "2024-05-20T09:15:00Z",
6       "cron": "0 8 * * MON-FRI",
7       "enabled": true,
8       "executionOptions": {
9         "retryOnFailure": true,
10         "maxRetries": 3
11       },
12       "flowId": "flow_123abc456def",
13       "flowName": "Daily Data Sync",
14       "id": "schedule_789xyz123abc",
15       "inputs": {
16         "source": "database",
17         "destination": "data_warehouse"
18       },
19       "lastRunAt": "2024-06-01T08:00:00Z",
20       "name": "Weekday Morning Sync",
21       "nextRunAt": "2024-06-03T08:00:00Z",
22       "organizationId": "org_456def789ghi",
23       "productSurfaceId": "surface_321fed654cba",
24       "recordIds": [
25         "record_001",
26         "record_002"
27       ],
28       "recordType": "sync_task",
29       "runAt": "08:00",
30       "timezone": "America/New_York",
31       "triggerType": "cron",
32       "updatedAt": "2024-05-25T12:00:00Z",
33       "userId": "user_abc123xyz789"
34     }
35   ]
36 }

List the schedules attached to a schedule-type surface.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

surfaceIdstringRequired

Response

List of schedules

datalist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error