Get Timeline

Returns a reservation's message timeline: every automated message from the host's message rules, oldest first. That is the messages scheduled to go out, and the ones sent, disabled by the host for this booking, failed or waiting to be retried, each with reason when it wasn't sent. For an Airbnb reservation it covers every reservation in the same Airbnb thread, as the Host Tools inbox does, so check reservationID on each row. Needs the messages:read scope.

After the messages comes one row for each message rule of the listing (its own, its listing groups' and the account-wide ones) with nothing for this reservation, with state paused, not_applicable or not_scheduled. So an empty timeline and a missing message can be told apart: a rule that is off or doesn't match says so, and a booking with no row for a rule has no such rule.

Until a message is sent, message is rendered from the rule each time you call, so it can change when the booking or the rule changes. Messages sent before Host Tools kept their text may have no message.

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

The reservation's ID

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 reservation with this ID 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