Sign in

v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Conversation Messages

Return the data for all ConversationMessages

Outlines the parameters, optional and required, used when requesting the data for all ConversationMessages

get/conversation_messages.json

Query parameters

conversation_idinteger required

The unique identifier for a single Conversation. Use the keyword null to match those without a ConversationMessage. The list will be filtered to include only the ConversationMessage records with the matching property.

created_sincestring date-time

Filter ConversationMessage records to those having the created_at field on the related Conversation after a specific time. (Expects an ISO-8601 timestamp).

fieldsstring

The fields to be returned. See response samples for what fields are available. For more information see the fields section.

ids[]integer

Filter ConversationMessage records to those having the specified unique identifiers.

limitinteger

A limit on the number of ConversationMessage records to be returned. Limit can range between 1 and 200. Default: 200.

order'id(asc)' | 'id(desc)'

Orders the ConversationMessage records by the given field. Default: id(asc).

page_tokenstring

A token specifying which page to return.

querystring

Wildcard search for body matching a given string.

updated_sincestring date-time

Filter ConversationMessage records to those having the updated_at field on the related Conversation after a specific time. (Expects an ISO-8601 timestamp).

Headers

X-API-VERSIONstring

The API minor version. Default: latest version.

Response

Ok