GET Conversations

get

https://sandbox.api.plumguide.com/v2/messaging/conversations

Returns the authenticated host's conversations, paginated.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

listingId

int32 | null

Return only conversations about this listing, which has to be one of the host's own.
It cannot be combined with readState, dateType, dateFrom, dateTo or bookingCode.

bookingCode

string | null

Return the single conversation belonging to this booking. Every booking has exactly one
conversation, so the result is that one thread, or nothing if the code is not one of the
host's bookings. It cannot be combined with readState, dateType, dateFrom, dateTo or
listingId.

readState

string

enum

Return only conversations the host has read, only ones not read yet, or all of them.
Defaults to all. A conversation counts as unread while it holds at least one message
addressed to the host that they have not opened.

Allowed:

dateType

string

enum

Which date dateFrom and dateTo apply to: when a message was sent or viewed, or the check in
or check out date of the stay. Leave it out and no date filtering happens at all, in which
case dateFrom and dateTo have to be left out too.

Allowed:

dateFrom

date-time | null

Earliest date to include. Needs dateType. Left out, the range starts 30 days ago for
MessageSent and MessageViewed, or today for CheckIn and CheckOut.

dateTo

date-time | null

Latest date to include. Needs dateType. Left out, the range ends today for MessageSent and
MessageViewed, or 12 months from today for CheckIn and CheckOut.

limit

int32

How many results that should be returned in the response

offSet

int32

The Offset to use for the first response

Responses

401

Unauthorized ensure your access token is correct

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns the host's conversations

400Filters were combined that cannot be used together, listingId is not a positive id, a date range was supplied without a dateType, or dateTo is earlier than dateFrom

403A listingId was supplied for a listing the host does not own

404A bookingCode was supplied and no conversation for it belongs to the host