Ashley DeBon: /* Successful Response (200) */

2026-07-17T13:02:41Z

‎Successful Response (200)

Ashley DeBon: Created page with "== Get Contact Custom Fields == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contact/custom-fields === Purpose === Retrieves the company’s conta..."

2026-07-17T13:02:10Z

Created page with "== Get Contact Custom Fields == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contact/custom-fields === Purpose === Retrieves the company’s conta..."

New page

== 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 ===
{| class="wikitable"
! 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.

{| class="wikitable"
! 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[] ====
{| class="wikitable"
! 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 <code>Start - </code> or <code>End - </code>)
|-
| position || integer || Display order of the field
|-
| required || boolean || Whether the field is required
|-
| custom_field_id || integer || Same as <code>id</code> (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[] ====
{| class="wikitable"
! 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 ===
{| class="wikitable"
! 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.

@@ Line 33: / Line 33: @@
 ==== Request Body ====
 None.
 === Successful Response (200) ===

Get Contact Custom Fields Detail - Revision history

Ashley DeBon: /* Successful Response (200) */

Ashley DeBon: Created page with "== Get Contact Custom Fields == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contact/custom-fields === Purpose === Retrieves the company’s conta..."