Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Browse collections

Retrieve collections

Retrieve collections for end users. To get specific collection items use the /browse/collection_id/<collection_id> endpoint.

get/browse/collections

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp
sectionstring

The section of the index to use. Defaults to Products.

Example:Products
num_results_per_pageinteger

The number of results per page to return.

Example:20
pageinteger

The page of results to return.

Example:1
offsetinteger

The number of results to skip from the beginning. Cannot be used together with page.

sort_by'id' | 'display_name'

The method to sort collections by.

Example:id
sort_order'ascending' | 'descending'
nowstring date-time

A date time representing the current moment in time when applying filtering by product age. Used to emulate "past/future" requests. Requires authentication.

Example:2024-01-15T10:30:00Z
origin_referrerstring

The url or app location where the request originated.

Example:https://example.com/search
cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-js-client-2.35.2
usstring[]

A customer defined context (such as vip-club-member) used to evaluate redirect or refined tag rules. Pass multiple segments by passing multiple us arguments.

[
  "vip-member"
]
uistring

A customer generated anonymized identifier for a user on a customer website. It should only be sent for logged in customers and helps Constructor to tie multiple client and session IDs together to form a behavioral data profile across devices.

Example:customer-user-id-456
string
OR
string[]
sinteger

An integer representing the users session number (starting with 1), incremented after a 30 minute period of inactivity.

Example:1
istring

A globally unique identifier for the user browser (or mobile application instance) making the request.

Example:user-device-id-123

Response

OK