Retrieve a schedule, with its recent occurrences

GET /v1/schedules/{id}

Scope: messages:read.

Send your API key as a bearer token: Authorization: Bearer ssms_sk_.... Test keys run this endpoint against the sandbox; see Authentication for key modes and scopes.

Path parameters

Name	Type	Required	Description
`id`	string	Yes

Responses

Status	Meaning	Body
200	The schedule	`Schedule`
401	Missing, malformed, or revoked API key	`Error`
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged	`Error`
404	Not found	`Error`
429	Rate limit or quota exceeded	`Error`

200: `Schedule` fields

Field	Type	Description
`id`	string	Example: `sch_a1B2c3D4e5F6g7H8`.
`object`	`schedule`
`to`	string
`from`	string
`body`	string
`repeat`	ScheduleRepeat
`start_date`	string (date)	Nullable.
`end_date`	string (date)	Nullable.
`max_occurrences`	integer	Nullable.
`active`	boolean
`status`	`active`, `paused`, `completed`
`paused_reason`	`manual`, `recipient_opted_out`, `repeated_failures`, `sender_unavailable`, `null`	Nullable.
`next_run_at`	string (date-time)	The next occurrence (UTC). Null unless active. Nullable.
`last_run_at`	string (date-time)	Nullable.
`last_status`	`sent`, `skipped_opted_out`, `skipped_missed`, `failed`, `null`	Nullable.
`last_error`	string	Why the last occurrence was skipped or failed. Nullable.
`last_message_id`	string	Nullable.
`counts`	object
`counts.sent`	integer
`counts.skipped`	integer
`counts.failed`	integer
`test`	boolean	Made with a test key: only ever sends in the sandbox.
`created_at`	string (date-time)
`updated_at`	string (date-time)
`recent_occurrences`	array of object	Only on GET /schedules/{id}: the last 10 occurrences, newest first.
`recent_occurrences[].date`	string (date)	The local calendar date of the occurrence.
`recent_occurrences[].due_at`	string (date-time)	Nullable.
`recent_occurrences[].status`	`sent`, `skipped_opted_out`, `skipped_missed`, `failed`
`recent_occurrences[].message_id`	string	Nullable.
`recent_occurrences[].error`	string	Nullable.

Errors

Status	When
401	Missing, malformed, or revoked API key
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
404	Not found
429	Rate limit or quota exceeded

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

json

{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}

Examples

curl

bash

curl -X GET "https://api.joinsimplesms.com/v1/schedules/ID" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY"

Node.js

The Node.js SDK does not wrap this endpoint yet; call it with fetch.

javascript

const res = await fetch('https://api.joinsimplesms.com/v1/schedules/ID', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SIMPLESMS_API_KEY}`,
  },
});

if (!res.ok) throw new Error((await res.json()).error.message);
const data = await res.json();

Python

The Python SDK does not wrap this endpoint yet; call it over HTTP.

python

import json, os, urllib.request

req = urllib.request.Request(
    "https://api.joinsimplesms.com/v1/schedules/ID",
    method="GET",
    headers={
        "Authorization": f"Bearer {os.environ['SIMPLESMS_API_KEY']}",
    },
)
with urllib.request.urlopen(req) as res:
    data = json.load(res)