GET
/
api
/
v1
/
accounts
/
{account_id}
/
custom_attribute_definitions
List all custom attributes in an account
curl --request GET \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/custom_attribute_definitions \
  --header 'api_access_token: <api-key>'
[
  {
    "id": 123,
    "attribute_display_name": "<string>",
    "attribute_display_type": "<string>",
    "attribute_description": "<string>",
    "attribute_key": "<string>",
    "regex_pattern": "<string>",
    "regex_cue": "<string>",
    "attribute_values": "<string>",
    "attribute_model": "<string>",
    "default_value": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  }
]

Authorizations

​
api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

​
account_id
integer
required

The numeric ID of the account

Query Parameters

​
attribute_model
enum<string>
required

conversation_attribute(0)/contact_attribute(1)

Available options:
0,
1

Response

Success

Array of all custom attributes

​
id
integer

Identifier

​
attribute_display_name
string

Attribute display name

​
attribute_display_type
string

Attribute display type (text, number, currency, percent, link, date, list, checkbox)

​
attribute_description
string

Attribute description

​
attribute_key
string

Attribute unique key value

​
regex_pattern
string

Regex pattern

​
regex_cue
string

Regex cue

​
attribute_values
string

Attribute values

​
attribute_model
string

Attribute type(conversation_attribute/contact_attribute)

​
default_value
string

Attribute default value

​
created_at
string

The date and time when the custom attribute was created

​
updated_at
string

The date and time when the custom attribute was updated