---
title: "List brands"
method: GET
path: "/v1/brands"
tags: ["brands"]
---

# List brands

`GET /v1/brands`

Each product can be assigned to one or more brands.

## Query parameters

- `ids` integer[]
- `slugs` string[]
- `page` integer
- `perPage` integer

## Response `200`

request successful

- BrandsResponse
  - `entities` Brand[]
    - `id` integer, required — The unique identifier of the brand (referred as `attributeId`), can be used for retrieving specific brand. ID which would be used to filter for brands in the `products` and `filters` endpoint
    - `slug` string, required — short text to describe the current category (usable, for example, in URLs as `fashion`).
    - `name` string, required
    - `customData` BrandCustomData, required — Arbitrary custom data object to be added to the brand.
    - `externalReference` string, required — External reference set by the client to integrate a third-party party system.
    - `group` string, required — Brand group.
    - `isActive` boolean, required — Whether the brand is currently active or not.
    - `logoHash` string, required — Logo hash used for generating the full url.
    - `createdAt` string, required — Date string, formatted according to RFC 3339, e.g. 2018-06-01T14:56:08+02:00
    - `updatedAt` string, required — Date string, formatted according to RFC 3339, e.g. 2018-06-01T14:56:08+02:00
    - `indexedAt` string, required — Date string, formatted according to RFC 3339, e.g. 2018-06-01T14:56:08+02:00
  - `pagination` union
    - Pagination
      - `current` integer, required
      - `first` integer, required
      - `last` integer, required
      - `next` integer, required
      - `page` integer, required
      - `perPage` integer, required
      - `prev` integer, required
      - `total` integer, required
    - OffsetPagination
      - `total` integer, required

## Other responses

- `400` — Required query parameter missing / invalid
- `401` — Authentication information is missing or invalid

## Changes

> 3 revisions in range; 1 could not be searched.

- **2023-08-06** `302b7c443b51` — 11 breaking, 8 info
  - the response property `entities/items/customData` became optional for the status `200`
  - the response property `entities/items/externalReference` became optional for the status `200`
  - the response property `pagination/oneOf[#/components/schemas/OffsetPagination]/total` became optional for the status `200`
  - the response property `pagination/oneOf[#/components/schemas/Pagination]/current` became optional for the status `200`
  - …15 more

[Change history](https://skmtc.dev/scayle/apis/storefront-api-documentation/changes/v1/brands/get.md)

---

[API](https://skmtc.dev/scayle/apis/storefront-api-documentation.md) · [All operations](https://skmtc.dev/scayle/apis/storefront-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/scayle/storefront-api-documentation/revisions/8cfa924ae703/schema)