Sign in

v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Custom Field Sets

Return the data for all CustomFieldSets

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

get/custom_field_sets.json

Query parameters

created_sincestring date-time

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

displayedboolean

Filter CustomFieldSet records to those that should be displayed by default.

fieldsstring

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

ids[]integer

Filter CustomFieldSet records to those having the specified unique identifiers.

limitinteger

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

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

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

page_tokenstring

A token specifying which page to return.

parent_type'Matter' | 'Contact'

Filter CustomFieldSet records to those that have the specified parent_type.

querystring

Wildcard search for name matching a given string.

updated_sincestring date-time

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