v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Conversations

Return the data for all Conversations

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

get/conversations.json

Query parameters

archivedboolean

Filter archived Conversation records.

contact_idinteger

Filter Conversation records for the contact.

created_sincestring date-time

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

datestring date

Filter Conversation records created on a given date. (Expects an ISO-8601 date).

fieldsstring

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

for_userboolean

If set to true, filter Conversation records accessible to any groups of the user. Note that the user may not be member of the conversations.

If set to false, filter Conversation records of which the user is a member.

ids[]integer

Filter Conversation records to those having the specified unique identifiers.

limitinteger

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

matter_idinteger

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

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

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

page_tokenstring

A token specifying which page to return.

read_statusboolean

Filter Conversation records to those which have been read.

time_entriesboolean

Filter Conversation records to those with or without associated time entries.

updated_sincestring date-time

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

Headers

X-API-VERSIONstring

The API minor version. Default: latest version.

Response

Ok