GET
/
catalog
/
categories
/
search
/
{query}
curl --request GET \
  --url https://sandbox-api.violet.io/v1/catalog/categories/search/{query}
{
  "content": [
    {
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "parent_id": "<string>",
      "depth": 123,
      "score": 123
    }
  ],
  "last": true,
  "total_pages": 123,
  "total_elements": 123,
  "first": true,
  "number_of_elements": 123,
  "size": 123,
  "number": 123,
  "empty": true,
  "next_page_cursor": "<string>",
  "pageable": {
    "page_number": 123,
    "page_size": 123,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    },
    "offset": 123,
    "paged": true,
    "unpaged": true
  },
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  }
}

Search Categories that match a given query.

The Categories you recieve will only be across Offers you have access to.

Headers

X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer

Path Parameters

query
string
required

Query Parameters

page
integer
default:1
size
integer
default:20

Response

default - application/json
default response

The response is of type object.