Skip to main content
GET
/
v2
/
schedules
/
{scheduleId}
curl https://qstash.upstash.io/v2/schedules/scd_1234 \
  -H "Authorization: Bearer <token>"

{
  createdAt: 1754565618803,
  scheduleId: "schedule-id",
  cron: "* * * * *",
  destination: "https://your-website/api",
  method: "GET",
  header: {
    "Content-Type": [ "application/json" ],
  },
  retries: 3,
  delay: 25,
  lastScheduleTime: 1755095280020,
  nextScheduleTime: 1759909800000,
  lastScheduleStates: {
    msg_7YoJxFpwk: "SUCCESS",
  },
  callerIP: "127.43.12.54",
  isPaused: true,
  parallelism: 0,
}

​
Request

​
scheduleId
string
required
The id of the schedule to retrieve.

​
Response

​
scheduleId
string
required
The id of the schedule.
​
cron
string
required
The cron expression used to schedule the message.
​
createdAt
int
required
The creation time of the object. UnixMilli
​
destination
string
required
Url or URL Group name
​
method
string
required
The HTTP method to use for the message.
​
header
Record<string, string[]>
The headers of the message.
​
body
string
The body of the message.
​
bodyBase64
string
The base64 encoded body of the message.
​
retries
int
The number of retries that should be attempted in case of delivery failure.
​
delay
int
The delay in seconds before the message is delivered.
​
callback
string
The url where we send a callback to after the message is delivered
​
failureCallback
string
The url where we send a callback to after the message delivery fails
​
callerIp
string
IP address where this schedule was created from.
​
isPaused
boolean
required
Whether the schedule is paused or not.
​
flowControlKey
string
The flow control key for rate limiting.
​
parallelism
int
The maximum number of parallel executions.
​
rate
int
The rate limit for this schedule.
​
period
int
The time interval during which the specified rate of requests can be activated using the same flow control key. In seconds.
​
retryDelayExpression
string
The retry delay expression for this schedule, if retry_delay was set when creating the schedule.
​
label
string
The label assigned to the schedule for filtering purposes.
​
lastScheduleTime
int
The timestamp of the last scheduled execution.
​
nextScheduleTime
int
The timestamp of the next scheduled execution.
​
lastScheduleStates
Record<string, string>
The states of the last scheduled messages. Maps message id to state (IN_PROGRESS, SUCCESS, FAIL).
​
callerIP
string
The IP address of the caller who created the schedule.
curl https://qstash.upstash.io/v2/schedules/scd_1234 \
  -H "Authorization: Bearer <token>"

{
  createdAt: 1754565618803,
  scheduleId: "schedule-id",
  cron: "* * * * *",
  destination: "https://your-website/api",
  method: "GET",
  header: {
    "Content-Type": [ "application/json" ],
  },
  retries: 3,
  delay: 25,
  lastScheduleTime: 1755095280020,
  nextScheduleTime: 1759909800000,
  lastScheduleStates: {
    msg_7YoJxFpwk: "SUCCESS",
  },
  callerIP: "127.43.12.54",
  isPaused: true,
  parallelism: 0,
}
⌘I