Skip to main content
GET
List conversations

Authorizations

x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Query Parameters

per_page
integer
default:30

Number of items to return per page.

Required range: 1 <= x <= 100
cursor
string

The cursor identifiying the page of data to fetch. If no cursor is provided, the query will return the first page of data. A cursor for the next page of data is provided in the response of this request.

business__in
string[]

Filter by business ids. Use a comma-separated list to provide multiple ids.

Example:

"a1c9f37b4deca92f83b61d02,9f4e2a8c0d73b154e621bc97,c73b15e9fa42d60b3a8c21ef"

last_message_date__gte
string<datetime>

Filter by the date of the last message of the conversation.

Return all the conversations whose last message date >= given_date.

For example: last_message_date__gte=2023-01-01T00:00:00Z will return all conversations whose last message was sent or received from the first of January 2023 onwards.

Note: the date must include an explicit UTC offset (e.g. the Z suffix, or +00:00). A date with no timezone information is rejected with a 400 error.

Combining this with last_message_date__lte defines a range: last_message_date__gte must not be later than last_message_date__lte, or the request is rejected with a 400 error.

Example:

"2023-01-01T00:00:00Z"

last_message_date__lte
string<datetime>

Filter by the date of the last message of the conversation.

Return all the conversations whose last message date <= given_date.

For example: last_message_date__lte=2023-01-31T23:59:59Z will return all conversations whose last message was sent or received up until the 31st of January 2023.

Note: the date must include an explicit UTC offset (e.g. the Z suffix, or +00:00). A date with no timezone information is rejected with a 400 error.

Combining this with last_message_date__gte defines a range: last_message_date__gte must not be later than last_message_date__lte, or the request is rejected with a 400 error.

Example:

"2023-01-31T23:59:59Z"

Response

OK

Response object

conversations
Conversation · object[]

The list of conversations, paginated.

count
integer

Total number of results available for the filters and dimensions requested.

Example:

1

next_cursor
string | null

The cursor to use in order to retrieve the next page of data. When all data have been fetched, the value is null.