Skip to main content
GET
/
v2
/
schedules
/
{scheduleId}
Get a Schedule
curl --request GET \
  --url https://qstash.upstash.io/v2/schedules/{scheduleId} \
  --header 'Authorization: Bearer <token>'
{
  "scheduleId": "<string>",
  "cron": "<string>",
  "destination": "<string>",
  "createdAt": 123,
  "method": "<string>",
  "isPaused": true,
  "header": {},
  "body": "<string>",
  "retries": 123,
  "delay": 123,
  "callback": "<string>",
  "failureCallback": "<string>",
  "callerIp": "<string>",
  "flowControlKey": "<string>",
  "parallelism": 123,
  "rate": 123,
  "period": 123,
  "retryDelayExpression": "<string>",
  "label": "<string>",
  "lastScheduleTime": 123,
  "nextScheduleTime": 123,
  "lastScheduleStates": {}
}

Authorizations

​
Authorization
string
header
required

QStash authentication token

Path Parameters

​
scheduleId
string
required

The ID of the schedule to retrieve.

Response

​
scheduleId
string
required

Unique identifier for the schedule

​
cron
string
required

The cron expression used to schedule the message

​
destination
string
required

The destination URL or URL Group name

​
createdAt
integer<int64>
required

The creation timestamp of the schedule in unix milliseconds

​
method
string
required

The HTTP method used for the scheduled message

​
isPaused
boolean
required

Whether the schedule is paused

​
header
object

Map of header names to arrays of header values

​
body
string

The body of the scheduled message

​
retries
integer

The number of retries for the scheduled message

​
delay
integer

The delay in seconds before the scheduled message is sent

​
callback
string

The callback URL for the scheduled message

​
failureCallback
string

The failure callback URL for the scheduled message

​
callerIp
string

The IP address of the client that created the schedule

​
flowControlKey
string

The flow control key used for rate limiting

​
parallelism
integer

The parallelism value used for flow control

​
rate
integer

The rate value used for flow control

​
period
integer

The period value used for flow control

​
retryDelayExpression
string

The retry delay expression used for calculating retry delays

​
label
string

The label assigned to the scheduled message

​
lastScheduleTime
integer<int64>

The last time the schedule was triggered in unix milliseconds

​
nextScheduleTime
integer<int64>

The next scheduled trigger time in unix milliseconds

​
lastScheduleStates
object

The states of the last scheduled messages