Get Contact Custom Fields Detail

Get Contact Custom Fields

Base URL

https://apimobile.callproof.com

Endpoint

/api/contact/custom-fields

Purpose

Retrieves the company’s contact-level custom fields used for contact filtering and forms. Image-type fields are excluded. Date and date-time fields are returned as separate Start and End filter fields. Auto-integer fields are returned as integer type.

HTTP Method

GET

Headers

Header	Required	Description
Authorization	Yes	Bearer access token

Security

• Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

None.

Query Parameters

None.

Request Body

None.

Successful Response (200)

Returns the contact custom field definitions for the authenticated user’s company.

Field	Type	Description
clientStatusCode	integer	Status indicator for the client (for example, 200)
user_id	integer	Identifier of the authenticated user
company_id	integer	Identifier of the authenticated user’s company
data	object	Custom field payload
uri	string	Requested resource URI

data.custom_fields[]

Field	Type	Description
id	integer	Unique identifier of the custom field
name	string	Display name of the custom field (for date/date-time fields, names may be prefixed with Start - or End - )
position	integer	Display order of the field
required	boolean	Whether the field is required
custom_field_id	integer	Same as id (custom field identifier)
custom_field_inner_id	integer	Related/inner custom field identifier, when configured
cfield_type_id	integer	Original custom field type identifier
custom_field_type_id	integer	Effective field type returned to the client (auto-integer is mapped to integer)
cfield_option_default_id	string	Default option identifier; returned as an empty string for this endpoint
custom_field_type	object	Field type details (includes type name)
custom_field_option	array	Available options for select/radio-style fields, ordered by position

data.custom_fields[].custom_field_option[]

Field	Type	Description
id	integer	Unique identifier of the option
cfield_id	integer	Parent custom field identifier
name	string	Option display name
position	integer	Option display order
points	integer	Option points value, when configured

Error Responses

Status Code	Meaning
400	Bad Request – custom fields could not be retrieved
401	Unauthorized – missing, invalid, or expired Bearer token

• 400 – An error occurred while loading contact custom fields.
• 401 – Authentication failed or the access token is missing/expired.