List Schedules

Returns all schedules in the account.

GET /schedules

List Schedules

cURL

curl --request GET \
  --url https://api.xplenty.com/{account_id}/api/schedules \
  --header 'Accept: <accept>' \
  --header 'Authorization: Basic <encoded-value>'

200

[
  {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "owner_id": 123,
    "start_at": "2023-11-07T05:31:56Z",
    "next_run_at": "2023-11-07T05:31:56Z",
    "interval_amount": 123,
    "task": {
      "nodes": 123,
      "packages": [
        {
          "package_id": 123,
          "variables": {}
        }
      ]
    },
    "overlap": true,
    "reuse_cluster": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "url": "<string>",
    "html_url": "<string>"
  }
]

Authorizations

Authorization · string · header · required

Enter your API key as the username. Leave the password field blank. Example: curl -u YOUR_API_KEY: https://api.xplenty.com/...

Headers

Accept · string · default: application/vnd.xplenty+json; version=2 · required

API version header — required on all requests

Query Parameters

offset · integer · default: 0

Index of the first object to retrieve (starting from 0)

Required range: x >= 0

limit · integer · default: 20

Number of items to return (max 100)

Required range: 1 <= x <= 100

status · enum<string>

Available options: enabled, disabled

sort · enum<string>

Available options: id, name, created_at, updated_at

direction · enum<string>

Available options: asc, desc

Response

200 - application/vnd.xplenty+json; version=2

Successful response

id · integer

name · string

description · string

status · enum<string>

Available options: enabled, disabled

owner_id · integer

start_at · string<date-time>

next_run_at · string<date-time> | null

interval_amount · integer

interval_unit · enum<string>

Available options: minutes, hours, days, weeks, months

task · object

Show child attributes

overlap · boolean

reuse_cluster · boolean

created_at · string<date-time>

updated_at · string<date-time>

url · string<uri>

html_url · string<uri>