Get Schedule

Retrieves a schedule by id.

GET /v2/schedules/{scheduleId}

curl

curl https://qstash.upstash.io/v2/schedules/scd_1234 \
  -H "Authorization: Bearer <token>"

const response = await fetch('https://qstash.upstash.io/v2/schedules/scd_1234', {
  headers: {
    'Authorization': 'Bearer <token>'
  }
});

import requests

headers = {
    'Authorization': 'Bearer <token>',
}

response = requests.get(
  'https://qstash.upstash.io/v2/schedules/scd_1234', 
  headers=headers
)

req, err := http.NewRequest("GET", "https://qstash.upstash.io/v2/schedules/scd_1234", nil)
if err != nil {
  log.Fatal(err)
}
req.Header.Set("Authorization", "Bearer <token>")
resp, err := http.DefaultClient.Do(req)
if err != nil {
  log.Fatal(err)
}
defer resp.Body.Close()

200 OK

{
  "scheduleId": "scd_1234",
  "createdAt": 1623345678001,
  "cron": "0 0 1 * *",
  "destination": "https://example.com",
  "method": "POST",
  "header": {
    "Content-Type": ["application/json"]
  },
  "body": "{\"message\":\"hello\"}",
  "retries": 3
}

Request

scheduleId · string · required

The id of the schedule to retrieve.

Response

createdAt · int · required

The creation time of the object. UnixMilli

scheduleId · string · required

The id of the schedule.

cron · string · required

The cron expression used to schedule the message.

callerIP · string · required

IP address where this schedule created from.

destination · string · required

Url or topic name

method · string · required

The HTTP method to use for the message.

header · Record<string, string[]> · required

The headers of the message.

body · string · required

The 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

curl

curl https://qstash.upstash.io/v2/schedules/scd_1234 \
  -H "Authorization: Bearer <token>"

const response = await fetch('https://qstash.upstash.io/v2/schedules/scd_1234', {
  headers: {
    'Authorization': 'Bearer <token>'
  }
});

import requests

headers = {
    'Authorization': 'Bearer <token>',
}

response = requests.get(
  'https://qstash.upstash.io/v2/schedules/scd_1234', 
  headers=headers
)

req, err := http.NewRequest("GET", "https://qstash.upstash.io/v2/schedules/scd_1234", nil)
if err != nil {
  log.Fatal(err)
}
req.Header.Set("Authorization", "Bearer <token>")
resp, err := http.DefaultClient.Do(req)
if err != nil {
  log.Fatal(err)
}
defer resp.Body.Close()

200 OK

{
  "scheduleId": "scd_1234",
  "createdAt": 1623345678001,
  "cron": "0 0 1 * *",
  "destination": "https://example.com",
  "method": "POST",
  "header": {
    "Content-Type": ["application/json"]
  },
  "body": "{\"message\":\"hello\"}",
  "retries": 3
}