Conversation Attributes

Get a conversation custom attribute by ID

Retrieves a single conversation custom attribute definition by its stable ID.

GET

/v2/conversation_attributes/{id}

curl --request GET \
  --url https://do.featurebase.app/v2/conversation_attributes/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit'

{
  "archived": false,
  "createdAt": "2026-06-09T16:00:19.000Z",
  "dataType": "number",
  "fieldSubType": "number",
  "id": "65d26304b2e65b1e1278170c",
  "identifier": "conversations.customFields.Minutes_to_Resolve",
  "name": "Minutes to Resolve",
  "object": "conversation_attribute",
  "options": [
    {
      "id": "65d26304b2e65b1e1278170d",
      "label": "Enterprise"
    }
  ],
  "required": false,
  "updatedAt": "2026-06-09T16:00:19.000Z"
}

Use this when a conversation response contains a customAttributes key and you need the corresponding display name, identifier, data type, field subtype, or options.

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Path Parameters

idstringrequired

Conversation custom attribute unique identifier

Example: 65d26304b2e65b1e1278170c

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover

Example: 2026-08-19.orbit

Response

Success

archivedbooleanrequired

Whether this definition has been archived.

Example: false

createdAtstring

ISO timestamp when the attribute was created.

Example: 2026-06-09T16:00:19.000Z

dataTypeenum<string>required

Storage-level data type used for validation and search.

Available options: string, number, boolean, date, array, object

Example: number

fieldSubTypeenum<string>required

Conversation field subtype that controls the expected value shape.

Available options: text, number, select, multi-select, checkbox, date

Example: number

idstringrequired

Stable machine identifier used as the key in conversation.customAttributes.

Example: 65d26304b2e65b1e1278170c

identifierstringrequired

Stable internal identifier for the attribute definition.

Example: conversations.customFields.Minutes_to_Resolve

namestringrequired

Human-readable attribute name shown in Featurebase.

Example: Minutes to Resolve

objectenum<string>required

Object type identifier

Available options: conversation_attribute

Example: conversation_attribute

optionsobject[]

Allowed values for select and multi-select attributes.

Show child attributes

requiredboolean

Whether teammates must set a value before closing a conversation from the Inbox. Closes via the API, workflows, and Fibi are not blocked.

Example: false

updatedAtstring

ISO timestamp when the attribute was last updated.

Example: 2026-06-09T16:00:19.000Z

Still need help? Ask the team