List Custoum Fields

Use this endpoint to retrieve all custom fields defined for your business, grouped by their field type.
Each field object includes essential metadata such as ID, display_name, and type.

This endpoint is typically used to:

Render dynamic forms based on the fields your business has configured.

Discover available field IDs before setting or updating contact values.

Map field types to the correct input format in your integration.

💡

Use this list to retrieve a field's id before calling endpoints that require field_id (for example: setting or updating a custom field value on a contact).

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
    "data": {
        "checkbox": [
            {
                "display_name": "string",
                "id": 0,
                "type": "string"
            }
        ],
        "chips": [
            {
                "display_name": "string",
                "id": 0,
                "type": "string"
            }
        ],
        "date": [
            {
                "display_name": "string",
                "id": 0,
                "type": "string"
            }
        ],
        "switch": [
            {
                "display_name": "string",
                "id": 0,
                "type": "string"
            }
        ],
        "text": [
            {
                "display_name": "string",
                "id": 0,
                "type": "string"
            }
        ],
        "time": [
            {
                "display_name": "string",
                "id": 0,
                "type": "string"
            }
        ],
        "url": [
            {
                "display_name": "string",
                "id": 0,
                "type": "string"
            }
        ]
    },
    "status": 0,
    "success": true
}

Request

Request Code Samples

Responses