Sign in

v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB
Custom Property

Get a Custom Property

Retrieves a specific custom property by its ID. Returns the complete property definition including all options for list types.

get/custom_properties/{customPropertyId}

Path parameters

customPropertyIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Custom Property Id

Response

OK

idstring uuid required

ID of the Custom Property.

namestring required

Name of the Custom Property.

type'text' | 'list' required

Type of the Custom Property.

valuestring required

Text value for text properties.

value_idsstring[] required

Array of option ids for list properties.

valuesstring[] required

Array of option values for list properties.

Example response

{
  "id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
  "name": "Department",
  "type": "text",
  "value": "Marketing"
}