Skip to main content
GET
/
collection
Get Collections
curl --request GET \
  --url https://api.catalogix.ai/v1/collection \
  --header 'Authorization: Bearer <token>'
{
  "status": {
    "code": 0,
    "message": "SUCCESS",
    "request_id": "8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312"
  },
  "data": [
    {
      "name": "Shirts",
      "description": "<string>",
      "thumbnail": "<string>",
      "status": "active",
      "url": "Shirts69b29578c653e5cf72206d77",
      "displayPreference": "product",
      "autoRefresh": true,
      "minProducts": 123,
      "totalProducts": 123,
      "meta": {
        "title": "<string>",
        "description": "<string>"
      },
      "sortBy": {
        "static": {
          "qualityScore": false,
          "trendScore": false,
          "personalization": false
        },
        "dynamic": [
          {}
        ]
      },
      "filters": {},
      "heroProducts": [
        "<string>"
      ],
      "groups": [
        {}
      ],
      "bannerUrl": "<string>",
      "static": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.streamoid.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Pass the API token as a Bearer token in the Authorization header.

Headers

​
X-Request-Id
string

Optional trace ID

Query Parameters

​
store_uuid
string
required

Store identifier

​
status
string

Comma-separated status filter. Allowed values: active, inactive, hidden.

​
limit
integer

Maximum number of collections to return (max: 1000).

Required range: x <= 1000

Response

Collections retrieved successfully

​
status
object
​
data
object[]