Schedules
Objects
List object schedules
Returns a paginated list of schedules for an object.
get/v1/objects/{collection}/{id}/schedules
Path parameters
idstring required
The ID of the object to list schedules for.
collectionstring required
The collection of the object to list schedules for.
Query parameters
tenantstring
Filter schedules by tenant id.
workflowstring
Filter schedules by workflow id.
afterstring
The cursor to fetch entries after.
beforestring
The cursor to fetch entries before.
page_sizeinteger
The number of items per page (defaults to 50).
Response
OK
Example response
{
"entries": [
{
"__typename": "Schedule",
"actor": null,
"data": null,
"id": "123e4567-e89b-12d3-a456-426614174000",
"inserted_at": "2021-01-01T00:00:00Z",
"last_occurrence_at": null,
"next_occurrence_at": null,
"recipient": {
"__typename": "User",
"avatar": null,
"created_at": null,
"email": "jane@ingen.net",
"id": "jane",
"name": "Jane Doe",
"phone_number": null,
"timezone": null,
"updated_at": "2024-05-22T12:00:00Z"
},
"repeats": [
{
"__typename": "ScheduleRepeat",
"day_of_month": null,
"days": [
"mon",
"tue",
"wed",
"thu",
"fri",
"sat",
"sun"
],
"frequency": "daily",
"hours": null,
"interval": 1,
"minutes": null
}
],
"tenant": null,
"updated_at": "2021-01-01T00:00:00Z",
"workflow": "workflow_123"
}
],
"page_info": {
"__typename": "PageInfo",
"after": null,
"before": null,
"page_size": 25
}
}