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 schedules
      • POSTCreate a schedule
      • GETGet results for a batch execution
      • GETList all schedule runs
      • GETGet results for a scheduled run
      • GETGet schedule sparklines
      • GETGet a schedule
      • PUTUpdate a schedule
      • DELDelete a schedule
      • POSTPause a schedule
      • POSTResume a schedule
      • POSTRun a schedule immediately
      • GETList runs for a schedule
      • GETGet schedule statistics
Dashboard
LogoLogo
Runtype APISchedules

Get a schedule

GET
/v1/schedules/:id
GET
/v1/schedules/:id
$curl https://api.runtype.com/v1/schedules/id \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json"
1{
2  "agentId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3  "createdAt": "2024-06-10T09:15:00Z",
4  "cron": "0 8 * * 1-5",
5  "enabled": true,
6  "executionOptions": {
7    "retryOnFailure": true,
8    "maxRetries": 3
9  },
10  "flowId": "f1234567-89ab-4cde-9012-3456789abcde",
11  "id": "s9876543-21fe-dcba-0987-654321fedcba",
12  "inputs": {
13    "param1": "value1",
14    "param2": 42
15  },
16  "lastRunAt": "2024-06-09T08:00:00Z",
17  "name": "Daily Data Sync",
18  "nextRunAt": "2024-06-10T08:00:00Z",
19  "organizationId": "org-1234567890abcdef",
20  "productSurfaceId": "prod-0987654321fedcba",
21  "recordIds": [
22    "rec-0011223344556677"
23  ],
24  "recordType": "databaseRecord",
25  "runAt": "2024-06-10T08:00:00Z",
26  "timezone": "America/New_York",
27  "triggerType": "cron",
28  "updatedAt": "2024-06-10T09:00:00Z",
29  "userId": "user-abcdef1234567890"
30}
Returns the details of a specific schedule.
Was this page helpful?
Previous

Update a schedule

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired

Response

Schedule details
agentIdstring or null
createdAtstring
cronstring or null
enabledboolean
executionOptionsmap from strings to any
flowIdstring 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
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
403
Forbidden Error
404
Not Found Error