Sign in

v1

latestOpenAPI 3.0.02026-07-23620132.5 KB
Custom properties / Structure items

List custom property structure items

Gets the list of structure items in the specified custom properties structure.

Use the API call GET /custom-property-structures?{organizationId} to get the ID of the custom property structure.

get/custom-property-structures/{customPropertyStructureId}/custom-property-structure-items

Path parameters

customPropertyStructureIdinteger required

The ID of the custom property structure. Use the API call GET /custom-property-structures?organizationId={organizationId} to get the ID of a custom property structure.

Query parameters

cols[]string[]

Specifies columns that are returned in the response. Use the cols[] parameter for every column that you want to return in the response. For example GET /endpoint?cols[]=key1&cols[]=key2 to get both key1 and key2 columns in the response.

Check the "Filtering" section for a full example.

pg[sortBy]'id' | 'name' | 'label' | 'description' | 'type' | 'required'

Specify the custom property item attribute. The custom property items in the response are sorted by the value of the attribute.

pg[offset]integer

The value of entities you want to skip before getting entities you need.

pg[sortDir]'asc' | 'desc'

The sorting order. It accepts the ascending and descending direction specifiers.

pg[limit]integer

Sets the maximum number of results per page in the API call response. For example, pg[limit]=100. The default number varies with different API endpoints.

Response

Successful response