query · Module: Jobs · Requires jobs:read
Arguments
| Argument | Type | Description |
|---|---|---|
type | String | Filter by type. |
status | String | Filter by status. |
createdGte | Int | Filter by created gte. |
createdLte | Int | Filter by created lte. |
limit | Int | Page size, 1–100 (default 10). |
startingAfter | ID | Cursor: return objects after this ID. |
endingBefore | ID | Cursor: return objects before this ID. |
Returns
JobScheduleList!
| Field | Type |
|---|---|
data | [JobSchedule!]! |
has_more | Boolean |
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query JobSchedules($limit: Int) {
jobSchedules(limit: $limit) {
data {
id
object
status
type
livemode
created
updated
recurrence {
frequency
interval
days
day_of_month
times
timezone
}
overlap
next_run_at
last_job
last_status
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"jobSchedules": {
"data": [
{
"id": "jsch_1a2B3c",
"object": "job_schedule",
"status": "active",
"type": "example",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"recurrence": {
"frequency": "daily",
"interval": 2,
"days": [
"mon"
],
"day_of_month": 2,
"times": [
"example"
],
"timezone": "Europe/London"
},
"overlap": "skip",
"next_run_at": 1791302400,
"last_job": "example",
"last_status": "queued"
}
],
"has_more": true
}
}
}