Custom fields

List the custom fields in your Exsited settings and read one by its id.

Custom fields are the extra fields set up in your Exsited settings. This area has 2 read-only endpoints, one to list the custom fields and one to read a single field, and all seven SDKs call every one.

At a glance

Endpoint	Method	Path	What it does
List custom fields	GET	/settings/custom_fields	Returns one page of the custom fields in your settings.
Retrieve a custom field	GET	/settings/custom_fields/{custom_field_id}	Returns one custom field, under custom_field.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• This area is read only. There are no create, update or delete calls for custom fields here.
• A custom field id starts with cfld_. Pass that id to read one field.
• One field comes back under custom_field. The listing puts its records under data.
• Listings page by cursor. Records sit under data; pass pagination.next_cursor as cursor to read the next page, and stop when pagination.has_more is false.