Sign in

v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Contacts

Return the data for all Contacts

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

get/contacts.json

Query parameters

client_onlyboolean

Filter Contact records to those that are clients.

clio_connect_onlyboolean

Filter Contact records to those that are Clio Connect users.

created_sincestring date-time

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

custom_field_ids[]integer

Filter Contact's custom_field_values to only include values for the given custom field unique identifiers.

custom_field_values'=' | '<' | '>' | '<=' | '>='

Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or, if the value type only supports one operator, the supported operator is used. In the latter case, no check for operator is performed on the input string. The key for the custom field value filter is the custom_field.id. e.g. custom_field_values[12345] If an operator is used for a type that does not support it, an 400 Bad Request is returned.

Supported operators:

  • checkbox, contact, matter, picklist : =

e.g. ?custom_field_values[1]=42

  • currency, date, time, numeric : =, <, >, <=, >=

e.g. ?custom_field_values[1]=>=105.4

  • email, text_area, text_line, url : =

e.g. ?custom_field_values[1]=url_encoded

Multiple conditions for the same custom field:

If you want to use more than one operator to filter a custom field, you can do so by passing in an array of values. e.g. ?custom_field_values[1]=[<=50, >=45]

email_onlyboolean

Filter Contact records to those that have email addresses.

exclude_ids[]integer

Filter Contact records to those who are not included in the given list of unique identifiers.

fieldsstring

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

ids[]integer

Filter Contact records to those having the specified unique identifiers.

initial'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' | 'O' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z'

Filter Contact records to those where the last name or company name start with the given initial.

limitinteger

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

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

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

page_tokenstring

A token specifying which page to return.

querystring

Wildcard search for name, title, email address, address, phone number, web site, instant messenger address, custom fields, related matter name, or company name matching a given string.

shared_resource_idinteger

Filter Contact records to those that currently have access to a given shared resource.

type'Company' | 'Person'

Filter Contact records to those that match the given type.

updated_sincestring date-time

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