List collections

GET 
/openapi/2026-07/collections

Retrieves a list of collections based on various filter criteria, such as product_id, title, or update timestamps.

Request

Query Parameters

cursor string

Cursor for pagination

page_size int32

A limit on the number of objects to return. Range: 1-100 (default is 10)

ids string[]

List of collection IDs to retrieve specific collections. Example: ?ids=1001&ids=1002

title string

Filter collections by their title (supports partial matching)

updated_at_min string

Minimum timestamp for filtering collections by their last updated date. Format: YYYY-MM-DDTHH:mm:ssZ

updated_at_max string

Maximum timestamp for filtering collections by their last updated date. Format: YYYY-MM-DDTHH:mm:ssZ

product_id string

UUID of a product to filter collections that include the product

smart boolean

Filter whether smart collection

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

collections object[]

List of collections

Array [

idstring

Collection ID

titlestring

Title

descriptionstring

Description

handlestring

URL-friendly identifier (handle)

smartboolean

Smart

image object

Image

srcstring

The source URL of the image

widthint32

The width of the image in pixels

heightint32

The height of the image in pixels

altstring

Alt text for the image

seo_titlestring

SEO title

seo_keywordsstring[]

SEO keywords

seo_descriptionstring

SEO description

sort_orderstring

Sort order

created_atstring

Creation timestamp, in ISO-8601 format

updated_atstring

Last update timestamp, in ISO-8601 format

match_rules object

Smart collection match rules

disjunctiveboolean

Whether conditions are disjunctive (OR)

rule_modules object[]

List of rule modules

Array [

disjunctiveboolean

Whether conditions are disjunctive (OR)

rules object[]

List of rules in this module

Array [

columnstring

Column

relationstring

Relation

conditionstring

Condition

]

]

tagsstring[]

List of tags for the collection

product_countint64

Number of products in the collection

]

cursorstring

Cursor for pagination

has_moreboolean

Whether there are more records

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "collections": [
      {
        "id": "string",
        "title": "string",
        "description": "string",
        "handle": "string",
        "smart": true,
        "image": {
          "src": "string",
          "width": 0,
          "height": 0,
          "alt": "string"
        },
        "seo_title": "string",
        "seo_keywords": [
          "string"
        ],
        "seo_description": "string",
        "sort_order": "string",
        "created_at": "string",
        "updated_at": "string",
        "match_rules": {
          "disjunctive": true,
          "rule_modules": [
            {
              "disjunctive": true,
              "rules": [
                {
                  "column": "string",
                  "relation": "string",
                  "condition": "string"
                }
              ]
            }
          ]
        },
        "tags": [
          "string"
        ],
        "product_count": 0
      }
    ],
    "cursor": "string",
    "has_more": true
  }
}