List all brands

Retrieves a paginated list of all brands for the app with optional filtering by name. Supports sorting by name, created_at, or updated_at in ascending or descending order. Includes brand details and all associated series for each brand.

GET/api/v1/{team_slug}/{app_slug}/brands

API: Management
OpenAPI: management-api
Updated: Apr 26, 2026

management-api:GET:/api/v1/{team_slug}/{app_slug}/brands

API ownership

API family: Management API
Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
Do not use from: Browser-only storefront code or public clients.
Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

Method: GET
Path: /api/v1/\{team_slug\}/\{app_slug\}/brands
Summary: List all brands
Description: Retrieves a paginated list of all brands for the app with optional filtering by name. Supports sorting by name, created_at, or updated_at in ascending or descending order. Includes brand details and all associated series for each brand.
OpenAPI contract: management-api
Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters7 parameters

Name	In	Required	Type	Description
app_slug	path	Yes	string	App slug
team_slug	path	Yes	string	Team slug
name	query	No	string	Name of brand used for filtering
page	query	No	integer	Page number
per-page	query	No	integer	Number of items per page (max 100)
sort-key	query	No	string	What key to sort on. One of name, created_at or updated_at
sort-order	query	No	string	Sort order, one of desc or asc

Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses4 statuses

Status	Description	Content
200	Brands returned successfully	application/json (object)
400	Invalid request (e.g. bad UUID, validation error)	application/json (object)
401	Unauthorized access	application/json (object)
500	Internal server error	application/json (object)

200 - object

Brand

Property	Type	Required	Details
`data`	object	No	-
`details`	string[]	No	Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
`success`	boolean	No	-

Brand

Property	Type	Required	Details
`address`	object	No	brand address
`cover`	object	No	-
`created_at`	string	No	-
`description`	string	No	brand description
`email`	string	No	brand email
`id`	string	No	unique id of brand
`logo`	object	No	-
`name`	string	No	name of brand
`series`	object[]	No	series connected to the brand
`slug`	string	No	slug of brand
`translations`	object	No	-
`updated_at`	string	No	-

Brand Address

Property	Type	Required	Details
`city`	string	No	-
`co_address`	string	No	-
`country`	string	No	-
`house_number`	string	No	-
`postal_code`	string	No	-
`state_province`	string	No	-
`street_address`	string	No	-

Brand Image

Property	Type	Required	Details
`id`	string	No	-
`url`	string	No	-

Brand Series

Property	Type	Required	Details
`id`	string	No	unique id of series
`name`	string	No	name of series
`slug`	string	No	name of series

Brand Translations

Property	Type	Required	Details
`description`	object[]	No	-

{
  "data": {
    "address": {
      "city": "string",
      "co_address": "string",
      "country": "string",
      "house_number": "string",
      "postal_code": "string",
      "state_province": "string",
      "street_address": "string"
    },
    "cover": {
      "id": "string",
      "url": "string"
    },
    "created_at": "string",
    "description": "string",
    "email": "string",
    "id": "string",
    "logo": {
      "id": "string",
      "url": "string"
    },
    "name": "string",
    "series": [
      {
        "id": "string",
        "name": "string",
        "slug": "string"
      }
    ],
    "slug": "string",
    "translations": {
      "description": [
        {
          "id": null,
          "locale": null,
          "value": null
        }
      ]
    },
    "updated_at": "string"
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

API family: Management API
Method: GET
Path: /api/v1/\{team_slug\}/\{app_slug\}/brands
Operation ID: Not documented in the OpenAPI contract.
OpenAPI tag: Brands
OpenAPI summary: List all brands