For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
    • Overview
  • Runtype API
      • GETList products
      • POSTCreate product
      • POSTAssemble product from FPO
      • GETGet product details
      • PUTUpdate product
      • DELDelete product
      • POSTAdd capability to product
      • PUTUpdate capability
      • DELRemove capability
      • GETPreview cleanup resources
      • GETGet product configuration summary
      • GETList surfaces
      • POSTCreate surface
      • GETGet surface details
      • PUTUpdate surface
      • DELDelete surface
      • POSTAdd item to surface
      • PUTUpdate surface item
      • DELRemove surface item
      • POSTCreate surface API key
      • DELDelete surface API key
      • GETReveal development surface key
      • GETList schedules for surface
      • POSTCreate schedule for surface
      • GETGet schedule details
      • PUTUpdate schedule
      • DELDelete schedule
      • POSTPause schedule
      • POSTResume schedule
      • POSTRun schedule immediately
Dashboard
LogoLogo
Runtype APIProducts

Get schedule details

GET
/v1/products/:id/surfaces/:surfaceId/schedules/:scheduleId
GET
/v1/products/:id/surfaces/:surfaceId/schedules/:scheduleId
$curl https://api.runtype.com/v1/products/id/surfaces/surfaceId/schedules/scheduleId \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json"
1{
2  "agentId": "agent_9f8b7c6d5e4a3b2c1d0e",
3  "createdAt": "2024-06-10T09:15:00Z",
4  "cron": "0 8 * * *",
5  "enabled": true,
6  "executionOptions": {
7    "retryOnFailure": true,
8    "maxRetries": 3
9  },
10  "flowId": "flow_123abc456def789ghi",
11  "flowName": "Daily Data Sync",
12  "id": "schedule_987zyx654wvu321tsr",
13  "inputs": {
14    "source": "database",
15    "destination": "data_warehouse"
16  },
17  "lastRunAt": "2024-06-09T08:00:00Z",
18  "name": "Morning Sync Schedule",
19  "nextRunAt": "2024-06-11T08:00:00Z",
20  "organizationId": "org_456def789abc123ghi",
21  "productSurfaceId": "surface_321tsr654wvu987zyx",
22  "recentRuns": [
23    {
24      "batchExecutionId": "batch_001122334455",
25      "completedAt": "2024-06-09T08:05:00Z",
26      "createdAt": "2024-06-09T07:59:00Z",
27      "error": null,
28      "id": "run_abc123def456",
29      "startedAt": "2024-06-09T08:00:00Z",
30      "status": "completed"
31    }
32  ],
33  "recordIds": [
34    "record_789ghi012jkl345mno"
35  ],
36  "recordType": "data_sync",
37  "runAt": "2024-06-10T08:00:00Z",
38  "timezone": "America/New_York",
39  "triggerType": "cron",
40  "updatedAt": "2024-06-10T09:20:00Z",
41  "userId": "user_1234567890abcdef"
42}
Get a schedule by ID including recent runs.
Was this page helpful?
Previous

Update schedule

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired
surfaceIdstringRequired
scheduleIdstringRequired

Response

Schedule details
agentIdstring or null
createdAtstring
cronstring or null
enabledboolean
executionOptionsmap from strings to any
flowIdstring or null
flowNamestring or null
idstring
inputsmap from strings to any or null
lastRunAtstring or null
namestring or null
nextRunAtstring or null
organizationIdstring or null
productSurfaceIdstring or null
recentRunslist of objects
recordIdslist of strings or null
recordTypestring or null
runAtstring or null
timezonestring or null
triggerTypestring
updatedAtstring
userIdstring
messagesany
recordFilterany

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error