---
title: "Retrieve collections"
method: GET
path: "/v1/collections"
tags: ["Collections"]
---

# Retrieve collections

`GET /v1/collections`

## Request

- Base URL: `https://ac.cnstrc.com`
- URL: `https://ac.cnstrc.com/v1/collections`
- Auth: one of:
  - HTTP basic
  - HTTP bearer

**🔐 This endpoint requires [HTTP authentication](https://docs.constructor.com/reference/main-authentication) (either [Basic](https://docs.constructor.com/reference/main-authentication#basic-authentication) or [Bearer](https://docs.constructor.com/reference/main-authentication#bearer-authentication)).**
For authenticating with Bearer token, required scopes are: `collections(r)`.

Retrieve all collections. By default, only base collections (collections with no `overridden_collection_id`) are returned. Use the `overridden_collection_id` query parameter to retrieve overriding collections for a specific base collection.

## Query parameters

- `key` string, required: The key of the index to use.
- `section` string: The section of the index to use. Defaults to `Products`.
- `id` string[]: The ID(s) of collections to filter by.
- `overridden_collection_id` string: When provided, returns only collections that override the specified collection ID.
- `query` string: A query to narrow the result set when listing collections. Matches on `id` or `display_name`.
- `num_results_per_page` integer: The number of results per page to return.
- `page` integer: The page of results to return.
- `offset` integer: The number of results to skip from the beginning. Cannot be used together with `page`.
- `sort_by` 'created_at' | 'updated_at' | 'display_name' | 'start_time' | 'end_time': The attribute to sort by. Accepted values are 'created_at', 'updated_at', 'display_name', 'start_time', 'end_time'
- `sort_order` 'ascending' | 'descending'
- `c` string: The ID of the client and version that the request is coming from, such as `cio-js-2.90`.
- `has_future_items` boolean: When true, only collections that have future items (items not yet in the catalog) will be returned. When false, only collections that do not have future items will be returned.

## Response `200`

OK

- CollectionListGetResponse
  - `collections` CollectionResponse[], required
    - `id` string, required: ID of the collection.
    - `display_name` string, required: Name of the collection to be displayed to end users.
    - `filter_expression` union
      - object
      - string, json
    - `data` object: Object containing additional data, that should be attached to this collection. The maximum size of data object is limited to 200kb.
    - `discoverable` boolean: When true, the collection is discoverable in autocomplete and search.
    - `matches` CollectionMatchResponse[]: A list of terms associated with this collection for matching purposes.
      - `pattern` string, required: A term to associate with this collection for matching purposes.
      - `match_type` 'EXACT' | 'UNORDERED' | 'PHRASE'
    - `start_time` string, date-time: ISO-8601 string in UTC defining start time when the collection becomes active. Any specified timezone will be omitted.
    - `end_time` string, date-time: ISO-8601 string in UTC defining start time when the collection becomes inactive. Any specified timezone will be omitted.
    - `overridden_collection_id` string: The ID of the base collection that this collection overrides. An overriding collection temporarily replaces the content of a base collection during a scheduled time window. Only base collections (collections with `overridden_collection_id` set to `null`) can be overridden.
    - `created_at` string, date-time, required: Collection creation date in ISO 8601 format. Present only for manually added collections.
    - `updated_at` string, date-time: Last collection update date in ISO 8601 format. Present only for manually added collections.
  - `total_count` integer, required

## Other responses

- `400`: Validation Error
- `401`: Credentials are not passed or action is forbidden.
- `403`: The supplied token does not have the required permissions.
- `429`: Rate limit breached

---

[API](https://skmtc.dev/constructor/apis/configuration.md) - [All operations](https://skmtc.dev/constructor/apis/configuration/llms.txt) - [OpenAPI document](https://skmtc.dev/constructor/apis/configuration/revisions/205ffdb5f494?raw)