a13nDocs
API referenceSchedules

List Schedule Occurrences

GET/api/v1/schedules/{schedule_id}/occurrences

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Path Parameters

schedule_id*Schedule Id

Query Parameters

limit?Limit
Range1 <= value <= 100
Default50
cursor?string|null
status?|null
trigger?|null
created_after?|null
created_before?|null
unfinished?boolean|null
include?string|null

Header Parameters

X-Workspace-ID?|

The workspace ID a login session acts in; required with a login session. An API key acts in its own workspace and needs none; naming another is forbidden.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/schedules/string/occurrences"
{  "items": [    {      "completed_at": "2019-08-24T14:15:22Z",      "completion_run_id": "string",      "covered_from_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "deadline_at": "2019-08-24T14:15:22Z",      "dispatch_attempts": 0,      "entry_id": "string",      "execution": {        "has_unfinished_work": true,        "initial_entry_status": "pending",        "initial_run": {          "id": "string",          "status": "accepted"        },        "observed_at": "2019-08-24T14:15:22Z"      },      "execution_outcome": "succeeded",      "finished_at": "2019-08-24T14:15:22Z",      "id": "string",      "last_error": "string",      "next_attempt_at": "2019-08-24T14:15:22Z",      "reason": "string",      "schedule_id": "string",      "schedule_version": 0,      "scheduled_at": "2019-08-24T14:15:22Z",      "session_id": "string",      "status": "pending",      "thread_id": "string",      "trigger": "scheduled",      "updated_at": "2019-08-24T14:15:22Z",      "version": 0    }  ],  "next_cursor": "string"}