Skip to navigation

Get Catalog Items

Retrieve a paginated list of catalog items for your organization.

Query parameters

pageintegerOptionalDefaults to 1
Page number to fetch.
limitintegerOptionalDefaults to 50
Number of records to return per page.
searchstringOptional

Keyword search across item names. Supports multiple words, exact phrases in quotes (“Granny Smith”), and exclusions (!banana).

item_typelist of stringsOptional
List of item type names or labels to filter by.
item_groupinglist of integersOptional
List of item grouping IDs to filter by.
tagslist of integersOptional
List of tag IDs to filter by. Items must match all provided tags.
publishbooleanOptionalDefaults to true
Filter by published status. Defaults to true.
include_expiredbooleanOptionalDefaults to false
Legacy flag to include all expired items.
expired_visibility_daysintegerOptionalDefaults to 0

Number of days past expiration to include items (0 = hide expired, -1 = show all).

Response headers

x-total-countintegerOptional
Total number of items matching the filter criteria.

Response

200 response
idintegerOptional
namestringOptional
short_descstring or nullOptional
descriptionstring or nullOptional
image_urlstring or nullOptionalformat: "uri"
item_typestring or nullOptional
item_groupingobject or nullOptional
item_attributesmap from strings to strings or nullOptional
display_dataobject or nullOptional
tagslist of stringsOptional
priceslist of objects or nullOptional