Skip to content
docs
Guides
ES
CatalogCollections
catalog:read

List collections

GET/v1/catalog/collections

List collections. A successful request returns HTTP 200 with the documented response body.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Query Parameters

limit?integer

Maximum number of results to return.

Formatint32
cursor?string

Opaque cursor from the previous response. Omit it on the first page.

search?string

Free-text filter. Which fields it covers depends on the resource.

sortBy?string

Field to sort by. Accepted values depend on the resource.

sortDirection?string

Sort direction: asc or desc.

Value in

  • "asc"
  • "desc"
type?string

Only this type.

Value in

  • "static"
  • "dynamic"
status?string

Only items in these statuses.

Value in

  • "draft"
  • "active"
types?array<>

Only these product types.

statuses?array<>

Only items in these statuses.

excludeTypes?array<>

Leave out these product types.

excludeStatuses?array<>
ids?array<ResourceId>

Only these identifiers.

Header Parameters

x-Store-Id?string

Store the request acts on. Not needed when the token is bound to a store.

Authorization*string

OAuth 2.0 bearer token.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/catalog/collections" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "data": [    {      "id": "7204558912004325301",      "storeId": "7204558912004325301",      "name": "Example resource",      "slug": "example-resource",      "status": "draft",      "image": {        "id": "7204558912004325301",        "url": "https://example.com/resource"      },      "type": "static",      "dynamicOperator": "and",      "validFrom": "2026-08-01T15:30:00Z",      "validTo": "2026-08-01T15:30:00Z",      "ruleCount": 1,      "overrideCount": 1,      "productCount": 1,      "createdOn": "2026-08-01T15:30:00Z",      "updatedOn": "2026-08-01T15:30:00Z"    }  ],  "hasNextPage": false,  "nextCursor": "example",  "totalCount": 1}