Get All Collections

Collection syncs can now be enabled using the Toggle Global Feature Flag endpoint.

Get All Collections

get

Retrieve a list of all Collections that you have access to.

Query parameters

pageinteger · int32OptionalDefault: 1

sizeinteger · int32OptionalDefault: 20

exclude_hiddenbooleanOptionalDefault: true

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

Responses

default

default response

application/json

get

/catalog/collections

HTTPcURLJavaScriptPython

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

default

default response

{
  "content": [
    {
      "id": 1,
      "external_id": "text",
      "merchant_id": 1,
      "parent_id": 1,
      "name": "text",
      "handle": "text",
      "description": "text",
      "status": "INACTIVE",
      "type": "CUSTOM",
      "media": {
        "source_url": "text",
        "alt": "text",
        "height": 1,
        "width": 1,
        "date_created": "2025-12-19T00:12:40.120Z"
      },
      "date_created": "2025-12-19T00:12:40.120Z",
      "date_last_modified": "2025-12-19T00:12:40.120Z"
    }
  ],
  "last": true,
  "total_pages": 1,
  "total_elements": 1,
  "first": true,
  "number_of_elements": 1,
  "size": 1,
  "number": 1,
  "empty": true,
  "next_page_cursor": "text",
  "pageable": {
    "page_number": 1,
    "page_size": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    },
    "offset": 1,
    "paged": true,
    "unpaged": true
  },
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  }
}