v50

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

Get paginated brand list

Retrieves all brands registered in the store's Catalog by page number.

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:

ProductCategoryResource
CatalogContentBrands

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/pagedlist

Query parameters

pageSizeinteger required
Example:5

Quantity of brands per page.

pageinteger required
Example:1

Page number of the 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

OK