Skip to main content

GET /categories

Returns a list of categories.

Address: GET https://instance_name/api/data/v1.3/categories/

Content-type: application/json

Request body parameters

limit integer

Number of results to return per page.

offset integer

The initial index from which to return the results.

Request example

curl –i –X GET
  https://test.inspector-cloud.com/api/data/v1.3/categories/ 
  -H ‘Authorization: Token <<your_token>>’ 
  –F "offset=30"

Response example

Response code: 200

{
  "count": 45,
  "next": "https://test.inspector-cloud.com/api/data/v1.0/categories/?limit=30&offset=30",
  "previous": null,
  "results": [
    {
      "id": 236,
      "name": "CANDIES"
    },
    {
      "id": 240,
      "name": "CHOCOLATE STICKS"
    },
    {
      "id": 255,
      "name": "COFFEE"
    },
    {
      "id": 257,
      "name": "COFFEE CAPSULES"
    },
    {
      "id": 258,
      "name": "CAT FOOD"
    },
    {
      "id": 260,
      "name": "DOG FOOD"
    },
    {
      "id": 261,
      "name": "FRUIT PUREE"
    },
    {
      "id": 263,
      "name": "JUICE DRINK"
    }
    ...
  ]
}

Response definitions

count integer

Required. Number of categories.

next string (uri) Nullable

Next page.

previous string (uri) Nullable

Previous page.

results Array of objects

Required. Array of objects with information about categories.

id integer

Category ID.

name string [ 1 .. 255 ] characters

Required. Category name.