v1

latestOpenAPI 3.0.32026-07-26870417.2 KB

custom properties

Get Custom Property

This endpoint retrieves a single custom property by its property_id or property_name, along with its options for dropdown and picklist kinds

If the same property name exists under both chat and ticket, pass the type query parameter to specify which one to fetch

If type is omitted and the name matches both, data is returned as an array containing every match

get/properties/{property_id}

Path parameters

property_idstring required

The property_id (e.g. property-xxxx) or the property_name of the custom property

Query parameters

type'chat' | 'ticket'

Specifies whether to resolve the chat or the ticket property when the same name exists under both

Response

200 OK. data is a single property object, or an array of property objects when the name matches both a chat and a ticket property and no type was given

successboolean

Example response

{
  "success": true,
  "data": {
    "property_id": "property-a1b2c3",
    "property_name": "Workspace",
    "type": "ticket",
    "kind": "dropdown",
    "section_id": "3f8b6c1e-8f2a-4b6e-9c3d-2a1f0e9d8c7b",
    "section_name": "Issue Details",
    "options": [
      {
        "id": "1712345678901",
        "label": "Acme Corp"
      }
    ],
    "created_at": "2026-07-06T10:00:00.000Z"
  }
}