Sign in

v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Communications

Return the data for all Communications

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

get/communications.json

Query parameters

contact_idinteger

The unique identifier for a single Contact. The keyword null is not valid for this field. The list will be filtered to include only the Communication records with the matching property.

created_sincestring date-time

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

datestring date

Filter Communication records to those that occur on the specified date (Expects an ISO-8601 date).

external_property_namestring

Filter records to only those with the given external property(s) name set.

e.g. ?external_property_name=Name

external_property_valuestring

Filter records to only those with the given external property(s) value set. Requires external property name as well.

e.g. ?external_property_name=Name&external_property_value=Value

fieldsstring

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

having_time_entriesboolean

Filter Communication records to those that do or do not have time entries.

ids[]integer

Filter Communication records to those having the specified unique identifiers.

limitinteger

A limit on the number of Communication 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 Communication. The list will be filtered to include only the Communication records with the matching property.

order'id(asc)' | 'id(desc)' | 'date(asc)' | 'date(desc)' | 'received_at(asc)' | 'received_at(desc)' | 'matter(asc)' | 'matter(desc)'

Orders the Communication records by the given field. Default: date(asc).

page_tokenstring

A token specifying which page to return.

querystring

Wildcard search for body or subject matching a given string.

received_atstring date-time

Filter Communication records to those that occur on the specified date (Expects an ISO-8601 date-time).

received_beforestring date-time

Filter Communication records to those whose date is on or before the date provided (Expects an ISO-8601 date).

received_sincestring date-time

Filter Communication records to those whose date is on or after the date provided (Expects an ISO-8601 date).

type'EmailCommunication' | 'PhoneCommunication'

Filter Communication records to those of the specified type.

updated_sincestring date-time

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

user_idinteger

The unique identifier for a single User. The keyword null is not valid for this field. The list will be filtered to include only the Communication records with the matching property.

Headers

X-API-VERSIONstring

The API minor version. Default: latest version.

Response

Ok