v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Relationships

Return the data for all Relationships

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

get/relationships.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 Relationship records with the matching property.

created_sincestring date-time

Filter Relationship records to those having the created_at field 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 Relationship records to those having the specified unique identifiers.

limitinteger

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

matter_idinteger

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

page_tokenstring

A token specifying which page to return.

updated_sincestring date-time

Filter Relationship 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