API
Data API

Categories

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



Return a list of categories.

GET /categories
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 categories.



next string (uri) Nullable

Next page.



previous string (uri) Nullable

Previous page.



results array of objects

An array of objects with information about categories.

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






Returns information about the category by ID.

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


Response parameters​



id integer

Category ID.



name string [ 1 .. 255 ] characters

Category name.






Updated 03 Mar 2023
Did this page help you?
PREVIOUS
Brands
NEXT
DQI types
Docs powered by Archbee