Skip to main content
GET
/
v1
/
product_collections
List
curl --request GET \
  --url https://{defaultHost}/v1/product_collections \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/product_collections"
  },
  "data": [
    {
      "id": "a24745e5-d3e5-4fc4-a070-c1d284f6bc3a",
      "object": "product_collection",
      "name": "Test Product Collection 1",
      "description": null,
      "metadata": {},
      "position": 0,
      "products_count": 0,
      "slug": "test-product-collection-1",
      "image": null,
      "created_at": 1767909735,
      "updated_at": 1767909735
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
ids[]
string[]

Only return objects with the given IDs.

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
page
integer

The page of items you want returned.

​
product_ids[]
string[]

Only return objects that belong to the given products.

​
query
string

The query to be used for full text search of this collection.

​
sort
string

The sorting column and order to be used for this collection. Available sorting columns for this endpoint are created_at, name, and updated_at.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.