Skip to main content
GET
List scheduled messages

Authorizations

Authorization
string
header
required

API token in the sk_live_… format.

Query Parameters

page
integer
default:1

Page number, starting at 1. An invalid value is treated as 1.

Required range: x >= 1
perPage
integer
default:20

Number of items per page. The maximum depends on the environment (default 100).

Required range: 1 <= x <= 100

Searches the message text or the contact.

contactId
integer

Only schedules addressed to this contact.

userId
integer

Only schedules created by this user. Use the user id in this company, the same one GET /users returns. The same person has a different id in each company they work in.

status
string

Response

200 - application/json

OK

data
object[]
meta
object
Example: