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.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
403The OAuth token lacks the messages:read scope
404No listing with this listingID belongs to the user
429Too many requests