v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-29208421.4 MB

Brand

Get brand list

Retrieves all brands registered in the store's Catalog.

⚠️ This route's response is limited to 20k results. If you need to obtain more results, please use the Get paginated brand list endpoint instead to get a paginated response.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources 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
Catalog	Content	Brands

There are no applicable predefined roles for this resource list. You must create a custom 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.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/api/catalog_system/pvt/brand/list

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

idinteger required

Brand's unique numerical identifier.

namestring required

Brand name.

isActiveboolean required

Defines if the brand is active (true) or not (false).

titlestring required

Meta title for the brand page.

metaTagDescriptionstring required

Meta Description for the brand page. A brief description of the brand, displayed by search engines. Since search engines can only display less than 150 characters, we recommend not exceeding this character limit when creating the description.

imageUrlstring nullable required

URL of the brand's image.