Skip to main content
GET
/
api
/
v1
/
:team_slug
/
:app_slug
/
brands
Error
A valid request URL is required to generate request examples
{
  "data": {
    "created_at": "<string>",
    "id": "<string>",
    "name": "<string>",
    "series": [
      {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>"
      }
    ],
    "slug": "<string>",
    "updated_at": "<string>"
  },
  "details": [
    "<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
​
details
string[]

Other information which can be relative to the response. This field is used to give additional information then the main data we want to return. For instance if a product do not match the publishing rules will the product status be set to Incomplete and this field will include why

​
success
boolean