List Schedules

This endpoint returns a list of all schedules.

Response

Schedules

Array<Schedule>

required

Show Schedule

content

Content

required

Show Content

body

Array<int>

required

The raw http request body encoded in base64.

header

Record<string, string[]>

required

The HTTP headers sent to your API.

createdAt

int

Unix timestamp with millisecond precision when the schedule was created.

cron

string

required

The cron expression.

destination

Destination

required

Destination of the schedule. The destination can either be a URL or a topic. Check the type field first to determine which one it is.

Show Destination

topic

Topic

Show child attributes

endpoints

Array<Endpoint>

required

Show Endpoint

endpointId

string

required

The id of the endpoint.

topicId

string

required

The id of the topic this endpoint subscribes to.

url

string

required

The url where all requests will be sent to.

name

string

required

A user given name must only contain alphanumeric, hyphen, underscore and periods.

topicId

string

required

Id for this topic

type

string

required

Determines the type of the destination, either topic or url. Depending on this field, either the topic or url field will be set.

url

string

The url of the destination. Only set if type is url.

scheduleId

string

required

The unique id of the schedule

settings

Settings

required

Show Settings

deadline

int

The time at which message should be delivered at the latest

delay

int

The delay in seconds before the message is delivered.

notBefore

int

The time before which the message should not be delivered.

retries

int

The number of retries that should be attempted in case of delivery failure.

callback

string

The delay in seconds before the message is delivered..

curl

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

200

[
  {
    "scheduleId": "scd_5mA1sL5RX6YphLfBnRTtiYPzZ8pt",
    "cron": "0 * * * *",
    "createdAt": 1691245856333,
    "content": {
      "header": {
        "Content-Type": ["application/json"]
      },
      "body": "{\"message\":\"hello\"}"
    },
    "destination": {
      "topic": {
        "topicId": "tpc_7EfEryZiheEKzpMuvjYdhhhbNNJA",
        "name": "test",
        "endpoints": [
          {
            "endpointId": "ept_6j7BNZus3ZyPy6P7QtLUMCC3Rq7h",
            "url": "https://www.example.com",
            "topicId": "tpc_7EfEryZiheEKzpMuvjYdhhhbNNJA"
          }
        ],
      "type": "url",
      "url": "https://www.example.com"
    },
    "settings": {
      "retries": 3
    }
  }
]