---
title: "Retrieves a collection of privacy protocols"
method: GET
path: "/v2/collections/{collectionId}"
---

# Retrieves a collection of privacy protocols

`GET /v2/collections/{collectionId}`

## Request

- Base URL: `https://uc.api.osano.com`
- URL: `https://uc.api.osano.com/v2/collections/{collectionId}`
- Auth: API key in header `x-uc-api-key`
- TypeScript: <https://skmtc.dev/osano/apis/unified-consent-core-api/docs/v2/collections/:collectionId/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a collection of privacy protocols by id

## Path parameters

- `collectionId` string, required

## Response `200`

The collection

- Def5
  - `collectionId` string
  - `name` string
  - `frameworks` string[]
  - `configIds` string[]
  - `jurisdiction` string
  - `created` string
  - `updated` string
  - `type` string
  - `consents` object[]
    - `privacyProtocolId` string, nullable: Privacy protocol id. Send it as the `target` of a consent action.
    - `name` string, nullable
    - `trigger` string, nullable
    - `type` 'consent' | 'preference' | 'null', nullable
    - `title` string, nullable
    - `description` string, nullable
    - `defaultAction` 'ACCEPT' | 'REJECT' | 'UNSELECTED' | 'null', nullable
    - `acceptWording` string, nullable
    - `rejectWording` string, nullable
    - `enabled` boolean, nullable
    - `collectionId` string, nullable
    - `frameworks` string[], nullable
    - `frameworkDefaults` object, nullable
      - `gpc` boolean: Whether GPC resolves this protocol to ACCEPT.
    - `integrations` object[], nullable
  - `preferences` object[]
    - `privacyProtocolId` string, nullable: Privacy protocol id. Send it as the `target` of a consent action.
    - `name` string, nullable
    - `trigger` string, nullable
    - `type` 'consent' | 'preference' | 'null', nullable
    - `title` string, nullable
    - `description` string, nullable
    - `defaultAction` 'ACCEPT' | 'REJECT' | 'UNSELECTED' | 'null', nullable
    - `acceptWording` string, nullable
    - `rejectWording` string, nullable
    - `enabled` boolean, nullable
    - `collectionId` string, nullable
    - `frameworks` string[], nullable
    - `frameworkDefaults` object, nullable
      - `gpc` boolean: Whether GPC resolves this protocol to ACCEPT.
    - `integrations` object[], nullable

## Changes

- **2026-11-06** `669b3b5b4d06`: 28 info
  - added the optional property `consents/items/acceptWording` to the response with the `200` status
  - added the optional property `consents/items/collectionId` to the response with the `200` status
  - added the optional property `consents/items/defaultAction` to the response with the `200` status
  - added the optional property `consents/items/description` to the response with the `200` status
  - …24 more
- **2024-12-26** `2fe8098661eb`: 1 warning
  - deleted the `query` request parameter `customerId`

[Operation history](https://skmtc.dev/osano/apis/unified-consent-core-api/changes/v2/collections/:collectionId/get.md)

---

[API](https://skmtc.dev/osano/apis/unified-consent-core-api.md) - [All operations](https://skmtc.dev/osano/apis/unified-consent-core-api/llms.txt) - [OpenAPI document](https://skmtc.dev/osano/apis/unified-consent-core-api/revisions/669b3b5b4d06?raw)