---
title: "Get information about brands"
method: GET
path: "/v1/brands"
tags: ["brands"]
---

# Get information about brands

`GET /v1/brands`

Each product can be assigned to one ore more brands. You can set up and modify brands through the [SCAYLE Panel](../../../en/next/manual/scayle). Please do not use digits only for brand slugs (example: 700), use letters only or combination of letters and digits (examples: mybrand, mybrand700).

## Query parameters

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

## 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
      - `floatData` number
      - `localizedJson` object[]
      - `localizedString` object[]
      - `nonLocalizedJson` string
      - `nonLocalizedString` string
    - `externalReference` string — 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
      - `first` integer
      - `last` integer
      - `next` integer
      - `page` integer
      - `perPage` integer
      - `prev` integer
      - `total` integer
    - OffsetPagination
      - `total` integer

## Changes

- **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/beabe2149947/schema)