List Properties

Beta
GET/v1/catalog/properties

This endpoint is idempotent. Learn more

Returns a paginated list of properties for the target account.

cursoroptional string

Query parameter: cursor for List Properties

limitoptional integer

Query parameter: limit for List Properties

qoptional string

Query parameter: q for List Properties

include[]optional arrayenumValues:attributes

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

objectstringenumValues:list

Object type for Property list

page_infoobject

Pagination metadata for Property list

next_cursorstringnullable

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

prev_cursorstringnullable

Cursor 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

Array of Property resources in this page

idstring

Property ID.

objectstringenumValues:property

Resource type identifier.

namestring

Name.

attributesobjectExpandablenullable

Attributes belonging to this property.

objectstringenumValues:list

Object type for Attribute list

page_infoobject

Pagination metadata for Attribute list

next_cursorstringnullable

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

prev_cursorstringnullable

Cursor 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

Array of Attribute resources in this page

idstring

Attribute ID.

objectstringenumValues:attribute

Resource type identifier.

valuestring

Attribute value.

colorstringenumValues:bluebrowndefault

Color code.

sort_orderinteger

Display order.

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 List Properties