Skip to main content
GET
List client custom properties

Authorizations

x-api-key
string
header
required

Send the API key in the x-api-key header.

Response

Custom properties defined for clients

id
string
required

Stable id of the property. This is what customProperties is keyed by on reads and writes — the display name can be renamed, this cannot.

Example:

"ca_warranty_count"

entity
enum<string>
required

The entity a custom property is defined for

Available options:
site,
conversation,
client
name
string
required

Display name, as configured in ProVision

Example:

"Warranty count"

type
string
required

Value type the property accepts

Example:

"number"

options
object[]
required

Selectable options for dropdown and multi_select; empty for every other type