Get conversations

Get conversations

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

Array of filters to query by.

field: Subject of the filter: status, type, guest._id, owner._id, reservation._id, reservation.status, read, assignee._id, listing._id

operator: Enhanced MongoDB comparison operator: $eq, $exists, $not, $contains, $notcontains, $gt, $lt, $between, $in, $nin

value: Value to filter by

string

Selection of fields, separated by space

string

Sorting, default: -createdAt

integer

Pagination, max: 100, default is: 25

string

Pagination cursor, default:'',

cursorAfter and cursorBefore are not allowed to be used at the same time in one request.

First request will require only limit parameter and in response you will get cursor object.

Use cursor.after to send in query params cursorAfter parameter in order to move forward.

Use cursor.before to send in query params cursorBefore parameter in order to move backwards.

An empty string in after or before cursor in response will indicate that there is no more documents in this direction.

If you sort buy something different than createdAt, please make sure include this parameter in fields, or you will get empty cursor.

cursorAfter and cursorBefore are not allowed to be used at the same time in one request.

string

Pagination cursor, default:null

string
enum
Defaults to guest
deprecated

Deprecated — use the type query parameter instead. The legacy name contains a space and is not transmitted correctly by generated clients.

Allowed:
string
enum
Defaults to guest

The conversations API supports guest, owner, and owner-direct conversations.

The query parameter type (guest, owner, or owner-direct; default: guest) determines which conversations are returned.

  • guest — guest inbox conversations
  • owner — owner conversations (includes owner and owner-guest records)
  • owner-direct — direct owner conversations

Owner and owner-direct conversations do not support airbnb2 module type; messages sent with platform module type are delivered through Email.

Allowed:
Responses

404

Conversations not found

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