Conversation Attributes

List conversation custom attributes

Returns conversation custom attribute definitions configured in your organization.

GET

/v2/conversation_attributes

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

{
  "data": [],
  "nextCursor": null,
  "object": "list"
}

Conversation payloads expose customAttributes keyed by stable attribute IDs. Use this endpoint to map those IDs to display names, identifiers, data types, field subtypes, and select options.

By default, archived definitions are excluded. Set includeArchived=true to include archived definitions.

Authorizations

Authorizationstringheaderrequired

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

Query Parameters

includeArchivedboolean | enum<string>query

Include archived conversation custom attributes in the response.

Example: false

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

dataobject[]required

Array of conversation custom attribute definitions.

Show child attributes

nextCursorstring | nullrequired

Cursor for fetching the next page. Always null; all definitions are returned at once.

objectenum<string>required

Object type identifier

Available options: list

Example: list

Still need help? Ask the team