Skip to main content
GET
Get a custom attribute

Authorizations

Authorization
string
header
required

The id_token from POST /auth/v1/signin, sent as Authorization: Bearer <id_token>. Not the access_token — that one does not carry the identity Cloud Chat authorizes on.

Headers

cloudchat-instance
integer
required

Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. The API overview explains how instances work, how to find yours, and the errors a wrong or missing value produces.

Example:

1

Path Parameters

accountId
integer
required

Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the cloudchat-instance header — the two travel together. Account numbers are only unique within an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.

Example:

1

customAttributeId
integer
required

The id returned when the custom attribute was created or listed.

Example:

42

Response

The definition.

One custom attribute definition: a field the account added to conversations, contacts or companies. The AI fill settings and visibility rules are not part of this view.

id
integer
required

The id getCustomAttribute takes.

Example:

42

key
string | null
required

The key the value is stored under on each contact, conversation or company, unique within model. Filled in for every definition in practice; null is possible only because the underlying column allows it.

Example:

"plan"

name
string | null
required

The name the Cloud Chat screen shows. Filled in for every definition in practice; null is possible only because the underlying column allows it.

Example:

"Plan"

description
string | null
required

What the field is for, as written by the administrator. null when none was written.

Example:

"Plan the customer subscribed to."

type
enum<string>
required

Kind of value the field holds: text, number, currency, percent, link, date, list (one of the options in values), checkbox or multi_list (several of the options in values).

Available options:
text,
number,
currency,
percent,
link,
date,
list,
checkbox,
multi_list
Example:

"list"

model
enum<string>
required

What the field is attached to: a conversation, a contact or a company.

Available options:
conversation,
contact,
company
Example:

"contact"

values
string[]
required

The options of a list or multi_list field, in order. Empty for every other type.

Example:
required
boolean
required

Whether the field has to be filled. For a conditional field it applies only while the field is shown.

Example:

false

regex_pattern
string | null
required

Pattern the text typed into this field has to match, as a plain pattern or a /pattern/flags literal. Cloud Chat enforces it on company values and on the screen and the website chat form; a contact or conversation value written through this API is not checked against it. null when there is none.

Example:

"/^[0-9]{11}$/"

regex_cue
string | null
required

What Cloud Chat tells the person when the text does not match regex_pattern. null when none was written.

Example:

"Only the 11 digits of the CPF."

conditional
boolean
required

true when the field only appears depending on the value of another field (a sub-list). Its parent is configured in the Cloud Chat screen.

Example:

false

created_at
string<date-time>
required
Example:

"2026-05-02T11:04:17.000Z"

updated_at
string<date-time>
required
Example:

"2026-05-02T11:04:17.000Z"