Schedules
Read a schedule
GET /v1/schedules/{id}: Read a schedule
GET /v1/schedules/{id}
| Operation id | getSchedule |
| Key scope | read: every key |
| Section | Schedules |
#Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | pattern ^sch_[0-9a-hjkmnp-tv-z]{26}$ |
#Example request
curl -X GET "https://api.kaab.ist/v1/schedules/{id}" \
-H "Authorization: Bearer $KAAB_API_KEY"
#Responses
#200
Schedule
{
"id": "sch_01j9zqk3q7m4n5p6r7s8t9v0wx",
"object": "schedule",
"program": "acme-report@production",
"inputs": {
"report_id": "42"
},
"cron": "*/30 * * * *",
"timezone": "Europe/Istanbul",
"status": "active",
"paused_reason": null,
"mode": "live",
"change_detection": {
"enabled": true,
"fields": [
"price"
]
},
"overlap_policy": "skip",
"catch_up": false,
"webhook_url": "https://hooks.acme.test/kaab",
"last_run_at": "2026-09-18T10:00:00Z",
"next_run_at": "2026-09-18T10:30:00Z",
"created_at": "2026-09-18T10:00:00Z"
}
#Errors
Every error answers with the error envelope; its code is one of the error codes.
| Status | When |
|---|---|
| 400 | request_invalid: request validation failed |
| 401 | Missing or invalid API key |
| 403 | The key's scope does not cover this operation |
| 404 | Resource not found |
| 429 | Rate limited; see Retry-After |
| 500 | internal: unexpected server error |