List Collections

Retrieve collections from a specific vendor with pagination

Retrieve collections from a specific vendor with pagination. Collections are ordered by product count (highest first) to prioritize the most comprehensive collections.

Request

x-api-key · string · required

Your API key for authentication

vendor · string · required

The vendor/brand name to filter by

page · number · required

Page number for pagination (minimum: 1)

page_size · number

Number of collections per page (minimum: 1, maximum: 100, default: 10)

Response

collections · array

Array of collection objects

Show Collection Object

id · string

Unique identifier for the collection

url · string

Collection URL

products_total · number

Total number of products in this collection

last_updated_by_catalog · string

ISO 8601 timestamp when the collection was last updated

meta · object

Pagination metadata

Show Meta Object

total_items · number

Total number of collections matching the query

total_pages · number

Total number of pages available

current_page · number

Current page number

page_size · number

Number of items per page

Error Responses

error · string

Error message describing what went wrong

details · string

Additional details about the error

cURL

curl -X POST https://api.getcatalog.ai/v1/collections \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor": "skims.com",
    "page": 1,
    "page_size": 20
  }'

Success Response

{
  "collections": [
    {
      "id": "clx789def012",
      "url": "https://skims.com/collections/basics",
      "products_total": 145,
      "last_updated_by_catalog": "2024-01-20T18:45:00Z"
    },
    {
      "id": "clx890ghi345",
      "url": "https://skims.com/collections/loungewear",
      "products_total": 89,
      "last_updated_by_catalog": "2024-01-19T12:30:00Z"
    }
  ],
  "meta": {
    "total_items": 25,
    "total_pages": 2,
    "current_page": 1,
    "page_size": 20
  }
}