Skip to content
Guides
ES
API reference
stablecatalog:read

List collections

GET/v1/catalog/collections

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

Value in

  • "static"
  • "dynamic"
status?string

Value in

  • "draft"
  • "active"
types?array<>
statuses?array<>
excludeTypes?array<>
excludeStatuses?array<>
ids?array<any>

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"
{  "data": [    {      "id": "string",      "storeId": "string",      "name": "string",      "slug": "string",      "status": "draft",      "image": null,      "type": "static",      "dynamicOperator": "and",      "validFrom": null,      "validTo": null,      "ruleCount": 0,      "overrideCount": 0,      "productCount": 0,      "createdOn": "2019-08-24T14:15:22Z",      "updatedOn": null    }  ],  "hasNextPage": true,  "nextCursor": null,  "totalCount": null}