Get Categories

Retrieve a list of categories that correspond to Offers that you have access to.

Get Categories

get

Query parameters

pageinteger · int32OptionalDefault: 1

sizeinteger · int32OptionalDefault: 20

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

Responses

200

successful operation

application/json

lastbooleanOptional

Boolean indicating if this is the last page

total_pagesinteger · int32Optional

The total count of pages available

total_elementsinteger · int32Optional

The total count of objects available

firstbooleanOptional

Boolean indicating if this is the first page of the response

number_of_elementsinteger · int32Optional

The total number of objects in this specific response

sizeinteger · int32Optional

The page size selected at request time

numberinteger · int32Optional

The page number selected at request time

emptybooleanOptional

Boolean indicating if the response content is empty

next_page_cursorstringOptional

Contains the cursor for the next page. This property will only be used for situations where the API does not support the page number/page size paradigm and it will mutually exclusive with the size/number fields in the response. If this property is returned it must be passed when requesting the next page from the API. Does not apply to endpoints that do not have a next_page_cursor query param documented.

403

insufficient permissions

application/json

get/catalog/categories

HTTPcURLJavaScriptPython

GET /v1/catalog/categories HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Accept: */*

{
  "content": [
    {
      "id": "187",
      "name": "Shoes",
      "slug": "shoes",
      "parent_id": "166",
      "depth": 2
    },
    {
      "id": "5697",
      "name": "Athletic Shoes",
      "slug": "athletic_shoes",
      "parent_id": "187",
      "depth": 3
    }
  ],
  "last": false,
  "total_pages": 3194,
  "total_elements": 6388,
  "first": true,
  "number_of_elements": 2,
  "size": 2,
  "number": 1,
  "empty": false,
  "pageable": {
    "page_number": 1,
    "page_size": 2,
    "sort": {
      "unsorted": false,
      "sorted": true,
      "empty": false
    },
    "offset": 0,
    "paged": true,
    "unpaged": false
  },
  "sort": {
    "unsorted": false,
    "sorted": true,
    "empty": false
  }
}