Get Timelines

Returns the scheduled messages of the whole account, or of one listing, whose sendDate is in a range, soonest first, a page at a time. Use it to answer "what goes out in the next 7 days" (state: scheduled) or "what was disabled" (state: disabled). Needs the messages:read scope.

It only holds messages scheduled ahead of time: check-in, check-out and during-the-stay rules. A message sent right when something happens (a booking confirmation, an inquiry reply, a changed check-in) and rule rows are only in Get Timeline for the reservation. Failures of those messages also come as the message.sendFailed error webhook.

The range defaults to the next 30 days and can be at most 92 days. When nextCursor isn't null, pass it as cursor with the same other parameters for the next page. A page can hold fewer rows than limit and still have a next page.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Only this listing's messages

string

ISO 8601 date or date-time, compared with sendDate. Defaults to now.

string

ISO 8601 date or date-time. Defaults to 30 days after startDate, and can be at most 92 days after it. A date alone includes the whole day (UTC).

string
enum

Only messages in this state

Allowed:
integer
1 to 200
Defaults to 100

Messages per page, 1 to 200

string

nextCursor from the previous page

Headers
string

Partner API key (deprecated — use OAuth 2.0 for new integrations)

string

User's authentication token (legacy). Use Authorization Bearer header for new integrations.

Responses

403

The OAuth token lacks the messages:read scope

404

No listing with this listingID belongs to the user

429

Too many requests

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json