Skip to content
docs
Guides
ES
CatalogBrands
catalog:read

List brands

Lists catalog brands by cursor, with text search, ID filtering, and sorting.

GET/v1/catalog/brands

Lists catalog brands by cursor, with text search, ID filtering, and sorting.

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"
ids?array<>

Only these identifiers.

isActive?boolean

Only active items.

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/brands" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "pageIndex": 1,  "pageSize": 1,  "count": 1,  "data": [    {      "id": "7204558912004325301",      "storeId": "7204558912004325301",      "name": "Example resource",      "slug": "example-resource",      "order": 1,      "createdOn": "2026-08-01T15:30:00Z",      "logo": "example",      "icon": "example"    }  ],  "totalPages": 1,  "hasPreviousPage": false,  "hasNextPage": false}