Sign InBook a Demo
Support

Collection APIs

GETGet Collections

Retrieve collections for a store, with optional status filtering.

GEThttps://api.catalogix.ai/v1/collection

Authorization

Authorizationstringrequiredheader
Bearer token, Bearer <token>. Create one under Tokens in your workspace.

Query parameters

store_uuidstringrequired
Store identifier
Example: 69785f41c2c01fdb81c697b3
statusstring
Comma-separated status filter. Allowed values: active, inactive, hidden.
Example: active,inactive
limitinteger
Maximum number of collections to return (max: 1000).

Headers

X-Request-Idstring
Optional trace ID

Responses

200Collections retrieved successfully
statusobject
Fields
codeinteger
0 = success, -1 = error
Example: 0
messagestring
Example: SUCCESS
request_idstring
Example: 8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312
dataobject[]
Item fields
namestring
Example: Shirts
descriptionstring
thumbnailstring
statusstring
Allowed: active inactive hidden
Example: active
urlstring
Example: Shirts69b29578c653e5cf72206d77
displayPreferencestring
Example: product
autoRefreshboolean
minProductsinteger
totalProductsinteger
metaobject
Fields
titlestring
descriptionstring
sortByobject
Fields
staticobject
Fields
qualityScoreboolean
Example: false
trendScoreboolean
Example: false
personalizationboolean
Example: false
dynamicobject[]
filtersobject
heroProductsstring[]
groupsobject[]
bannerUrlstring
staticstring
400Validation error
statusstringdefault: "error"
The status of the request, typically 'error'
detailstringrequired
A description of the error
401Unauthorized – Bearer token missing or invalid
statusobject
Fields
codeinteger
Example: -1
messagestring
Example: Unauthorized – invalid or missing Bearer token
500Internal server error
statusobject
Fields
codeinteger
Example: -1
messagestring
Example: Internal server error. Please contact support@catalogix.ai
502Downstream service unavailable
statusstringdefault: "error"
The status of the request, typically 'error'
detailstringrequired
A description of the error

Something missing or unclear? Write to support@streamoid.com.

esc