Get custom attributes schema

Retrieves the custom attributes schema for contacts

GET /chatbots/{chatbotId}/custom-attributes

Get custom attributes schema

cURL

curl --request GET \
  --url https://www.chatbase.co/api/v1/chatbots/{chatbotId}/custom-attributes \
  --header 'Authorization: Bearer <token>'

200

{
  "message": "Success",
  "data": [
    {
      "name": "department",
      "label": "Department",
      "type": "text",
      "description": "Employee department",
      "archived": false
    }
  ]
}

Authorizations

Authorization · string · header · required

API key in Bearer token format

Path Parameters

chatbotId · string · required

ID of the chatbot

Response

200

application/json

Custom attributes schema retrieved successfully

message · string

Example:

"Success"

data · object[]

Array of custom attribute definitions

Show child attributes