Get Fields List

Overview

Get custom fields list.

Available for Staff, App, and Directory tokens

Every business starts with the built-in contact fields Email, First Name, Last Name, Phone, Address, and Birthday; fields created with POST /platform/v1/fields are listed after them.

Response shape

data is a flat array of field definitions, not an object. Each element has id (the field UID), type, label, object_type (contact or matter), required, and deleted; dropdown fields also carry options. Contact-level and matter-level fields come back together, in position order, and deleted fields are included (deleted: true).

No filtering or paging

The endpoint takes no query parameters: it always returns every field of the business in one response. To find a specific field, filter the array on the client side. For example, the matter name field required by POST /business/clients/v1/contacts/{client_uid}/matters is the element with type == "name", object_type == "matter" and deleted == false; its position in the array is not fixed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json