Skip to main content
GET
List scheduled sends

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

X-Device-Id
string

Device identifier for multi-device support. Required when multiple devices are registered. If only one device is registered, it will be used as the default. Can also be provided as device_id query parameter.

Example:

"my-device-id"

Query Parameters

status
enum<string>

Only schedules in this status

Available options:
active,
running,
paused,
completed,
failed,
cancelled

Match the recipient or the message text

message_type
enum<string>

Only this kind of scheduled send

Available options:
text,
image,
file,
video,
audio,
sticker,
contact,
link,
location,
poll,
forward
limit
integer
default:25

Maximum number of schedules to return

Required range: 1 <= x <= 100
offset
integer
default:0

Number of schedules to skip (for pagination)

Required range: x >= 0

Response

OK

code
string
Example:

"SUCCESS"

message
string
Example:

"Schedules fetched"

results
object