API
Data API

Brands

Methods allow you to get a list of portal brands or information on a specific brand.



Return a list of brands.

GET /brands
GET
Request
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
limit
optional
Integer
The number of results to return per page.
offset
optional
Integer
The initial index from which to return the results.


Response parameters​



count integer

The number of brands.



next string (uri) Nullable

Next page.



previous string (uri) Nullable

Previous page.



results array of objects

An array of objects with information about brands.

  • id integer Brand ID.
  • name string [ 1 .. 255 ] characters Brand name.






Return information about the brand by ID.

GET /brand/{id}
GET
Request
Path Params
id
required
String
Brand ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.


Response parameters​



id integer

Brand ID.



name string [ 1 .. 255 ] characters

Brand name.






Updated 03 Mar 2023
Did this page help you?
PREVIOUS
Agents
NEXT
Categories
Docs powered by Archbee