Retrieve Property

Beta
GET/v1/catalog/properties/{id}

This endpoint is idempotent. Learn more

Returns a property by ID.

idstring

Property ID.

include[]optional arrayenumValues:attributes

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

idstring

Property ID.

objectstringenumValues:property

Resource type identifier.

namestring

Display name.

attributesobjectExpandablenullable

Attributes belonging to this property.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

URL to fetch the next page, null if no more pages.

previous_page_urlstringnullable

URL to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

idstring

Attribute ID.

objectstringenumValues:attribute

Resource type identifier.

valuestring

Attribute value.

colorstringenumValues:bluebrowndefault

Color code.

sort_orderinteger

Display order.

propertyobjectnullable

Property this attribute belongs to (set when the attribute is returned under item.attributes).

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

Responses

200

Successful response for Retrieve Property