List all brands

GET

api

{team_slug}

{app_slug}

brands

Error

A valid request URL is required to generate request examples

{
  "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": "<string>",
          "locale": "<string>",
          "value": "<string>"
        }
      ]
    },
    "updated_at": "<string>"
  },
  "details": [
    "<string>"
  ],
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

Path Parameters

app_slug

string

required

App slug

team_slug

string

required

Team slug

Query Parameters

name

string

Name of brand used for filtering

page

integer

Page number

per-page

integer

Number of items per page (max 100)

sort-key

string

What key to sort on. One of name, created_at or updated_at

sort-order

string

Sort order, one of desc or asc

Response

Brands returned successfully

data

object

Show child attributes

details

string[]

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

Create a new brandCreates a new brand with the provided name, slug, logo, cover image, and description. Validates that the brand name and slug are unique within the app.

Error

A valid request URL is required to generate request examples

{
  "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": "<string>",
          "locale": "<string>",
          "value": "<string>"
        }
      ]
    },
    "updated_at": "<string>"
  },
  "details": [
    "<string>"
  ],
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

Management API

Shopper API

Customers API

Digital Assets Management API

Path Parameters

Query Parameters

Response