---
title: "Get list of brands"
method: GET
path: "/api/catalog-seller-portal/brands"
tags: ["Brand"]
---

# Get list of brands

`GET /api/catalog-seller-portal/brands`

## Request

- Base URL: `https://apiexamples.vtexcommercestable.com.br`
- URL: `https://apiexamples.vtexcommercestable.com.br/api/catalog-seller-portal/brands`
- Auth: one of:
  - API key in header `X-VTEX-API-AppKey` and API key in header `X-VTEX-API-AppToken`
  - API key in header `VtexIdclientAutCookie`

>📘 This API is part of the [Seller Portal Catalog](https://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp). This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact [our Support Center](https://support.vtex.com/hc/en-us/requests). 

 Retrieves general information about all brands of the store. It is mandatory to use at least one query parameter.

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| CatalogV2 | Management | **Brand Read** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Query parameters

- `q` string
- `from` string
- `to` string
- `orderBy` string
- `name` string

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

OK

- object
  - `data` object[], required: List with information about the store's brands.
    - `id` string, required: Brand unique identifier number.
    - `name` string, required: Brand name.
    - `isActive` boolean, required: The condition defines if the brand is active (`true`) or inactive (`false`).
    - `createdAt` string, required: Date when the brand was created.
    - `updatedAt` string, required: Last date when the brand was updated.
  - `_metadata` object, required: Information about the organization and exhibition of the brand list.
    - `total` integer, required: Total of brands on the list.
    - `from` integer, required: The first page of the interval of the brand list.
    - `to` integer, required: The last page of the interval of the brand list.
    - `orderBy` string, required: The order that the list is displayed. You can select `name`, or `updated_at` to select the order criteria. Then you can add `,` , `asc` or `desc` to define the brands order.

---

[API](https://skmtc.dev/vtex/apis/catalog-api-seller-portal.md) - [All operations](https://skmtc.dev/vtex/apis/catalog-api-seller-portal/llms.txt) - [OpenAPI document](https://skmtc.dev/vtex/apis/catalog-api-seller-portal/revisions/5d0859a36e88?raw)