v1

latestOpenAPI 3.0.02026-07-26870415.2 KB

custom_attributes

List custom attribute definitions

Returns the workspace's custom attribute definitions, including types, select options, and section metadata.

get/v1/custom-attributes

Query parameters

workspace_idstring required

Workspace to query.

Example:j57demo8f8x7c9v0n2q4r6t8y1u3i5o

Response

Custom attribute definitions

Example response

{
  "data": [
    {
      "id": "attr_123",
      "workspace_id": "j57demo8f8x7c9v0n2q4r6t8y1u3i5o",
      "name": "VIP Status",
      "type": "Select",
      "options": [
        {
          "value": "standard",
          "color": "gray"
        },
        {
          "value": "vip",
          "color": "green"
        }
      ],
      "order": 1,
      "section_id": "section_123",
      "section_name": "Contact Info"
    }
  ]
}