Sign in

v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Custom Fields

Return the data for all CustomFields

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

get/custom_fields.json

Query parameters

created_sincestring date-time

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

deletedboolean

Filter CustomField records to those that have been deleted for future use.

field_type'checkbox' | 'contact' | 'currency' | 'date' | 'time' | 'email' | 'matter' | 'numeric' | 'picklist' | 'text_area' | 'text_line' | 'url'

Field type of this custom field

fieldsstring

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

ids[]integer

Filter CustomField records to those having the specified unique identifiers.

limitinteger

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

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

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

page_tokenstring

A token specifying which page to return.

parent_type'matter' | 'contact'

Filter CustomField records to those that have the specified parent_type.

querystring

Wildcard search for name matching a given string.

updated_sincestring date-time

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

visible_and_requiredboolean

Filter CustomField records to those that are visible and required.

Headers

X-API-VERSIONstring

The API minor version. Default: latest version.

Response

Ok