Get a Schedule
Get details of a specific schedule
curl --request GET \
--url https://qstash-{region}.upstash.io/v2/schedules/{scheduleId} \
--header 'Authorization: Bearer <token>'{
"scheduleId": "<string>",
"cron": "<string>",
"destination": "<string>",
"createdAt": 123,
"method": "<string>",
"header": "<string>",
"body": "<string>",
"retries": 123,
"delay": 123,
"callback": "<string>",
"failureCallback": "<string>",
"callerIp": "<string>",
"isPaused": true,
"flowControlKey": "<string>",
"parallelism": 123,
"rate": 123,
"period": 123,
"retryDelayExpression": "<string>",
"label": "<string>",
"labels": [
"<string>"
],
"lastScheduleTime": 123,
"nextScheduleTime": 123,
"lastScheduleStates": "<string>"
}Authorization
Bearer authentication header of the form Bearer <token>.
Path parameters
The ID of the schedule to retrieve.
Response
200
Unique identifier for the schedule
The cron expression used to schedule the message
The destination URL or URL Group name
The creation timestamp of the schedule in unix milliseconds
The HTTP method used for the scheduled message
Map of header names to arrays of header values
The body of the scheduled message
The number of retries for the scheduled message
The delay in seconds before the scheduled message is sent
The callback URL for the scheduled message
The failure callback URL for the scheduled message
The IP address of the client that created the schedule
Whether the schedule is paused
The flow control key used for rate limiting
The parallelism value used for flow control
The rate value used for flow control
The period value used for flow control
The retry delay expression used for calculating retry delays
The label assigned to the scheduled message. Deprecated in favor of labels.
The list of labels assigned to the scheduled message.
The last time the schedule was triggered in unix milliseconds
The next scheduled trigger time in unix milliseconds
The states of the last scheduled messages
404 — Schedule not found
Error message