Custom Fields

This resource lists the custom fields in your workspace. Custom fields are properties on a Client that you can use to store metadata about them (e.g. “Website URL” or “Service Tier”).

The format and data-type of each custom field in your workspace is stored in this resource, while the values for a custom field are stored directly on the Client resource.

To update the value of a custom field on a Client, you can call Update Client and include customFields in the body. See notes on Create a Client for an example on how to format the customFields object.

Properties

idstring

The unique identifier for this item.

typestring

The data-type of this Custom Field. Can be text, multiSelect, email, address, url, number, or phoneNumber.

namestring

Display name of the field in your workspace.

keystring

Unique identifier used by the API to denote this custom field in READ and UPDATE queries on Clients. key is auto-generated, typically a camelCase version of the name of the custom field. (e.g. Support Email -> supportEmail)

ordernumber

Represents the visual ordering (zero-indexed) of this field amongst all custom fields on the client details page.

optionsarray of custom field options

Only relevant for multiSelect fields. If present, represents the available options in the dropdown for that field. The structure of custom field options is defined in the Custom Field Options Resource

entityType:string

The type of entity that this custom field is associated with. Can be one of client or company.

Example List of all Custom Fields in a workspace

{
    "data": [
        {
            "id": "f1eaf544-6da4-457b-bea8-3777a2eeefa9",
            "type": "phoneNumber",
            "name": "Phone Number",
            "key": "phoneNumber",
            "order": 0,
            "entityType": "company"
        },
        {
            "id": "71cc12f5-32ce-496f-8fa7-51a5f63b38a4",
            "type": "url",
            "name": "Website",
            "key": "website",
            "order": 2,
            "entityType": "client"
        },
        {
            "id": "71813f92-3c9f-4161-835e-e0b4b9d4d130",
            "type": "email",
            "name": "Support Email",
            "key": "supportEmail",
            "order": 0,
            "entityType": "client"
        },
        {
            "id": "7b1f2546-e01f-4279-94c0-0323d004dfdd",
            "type": "text",
            "name": "Pronouns",
            "key": "pronouns",
            "order": 1,
            "entityType": "client"
        },
        {
            "id": "8465086b-29e9-4c0f-ae84-1f9246a2bc01",
            "type": "number",
            "name": "Access Code",
            "key": "accessCode",
            "order": 5,
            "entityType": "client"
        },
        {
            "id": "7058565d-1753-4ca0-bbf3-3ec95121681b",
            "type": "multiSelect",
            "name": "Services",
            "key": "services",
            "order": 3,
            "options": [
                {
                    "id": "option-123456",
                    "name": "File Sharing",
                    "key": "fileSharing",
                    "color": "rgba(144, 149, 157, 1)"
                },
                {
                    "id": "option-123457",
                    "name": "Metrics",
                    "key": "metrics",
                    "color": "rgba(0, 0, 0, 1)"
                },
                {
                    "id": "option-123458",
                    "name": "Messaging",
                    "key": "messaging",
                    "color": "rgba(27, 29, 0, 1)"
                }
            ],
            "entityType": "client"
        },
        {
            "id": "f1eaf544-6da4-457b-bea8-3777a2eeefa7",
            "type": "phoneNumber",
            "name": "Phone Number",
            "key": "phoneNumber",
            "order": 4,
            "entityType": "client"
        }
    ]
}