---
title: "GET /v2/config"
method: GET
path: "/v2/config"
---

# GET /v2/config

`GET /v2/config`

## Request

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

Retrieves a UC config

## Response `200`

The UC config

- Def20
  - `configId` string
  - `customerId` string
  - `name` string
  - `domains` string[]
  - `privacyPolicyUrl` string
  - `privacyPolicyVersion` integer
  - `processingTime` integer
  - `processingUnit` string
  - `privacyProtocols` Def8[]
    - `privacyProtocolId` string
    - `name` string
    - `type` string
    - `integrations` Def7[]
      - `connection` object
        - `label` string
        - `value` string
      - `operation` object
        - `label` string
        - `value` string
      - `additionalFields` boolean
      - `fields` object
      - `protocolValue` string[]
    - `enabled` boolean
    - `trigger` string
  - `jurisdictionLookup` string
  - `homepageUrl` string
  - `created` string
  - `updated` string
  - `helpUrl` string
  - `frameworks` string[]
  - `headings` Def9
    - `fontFamily` string
    - `color` string
    - `backgroundColor` string
  - `paragraphs` Def9
    - `fontFamily` string
    - `color` string
    - `backgroundColor` string
  - `links` Def9
    - `fontFamily` string
    - `color` string
    - `backgroundColor` string
  - `primaryButtons` Def9
    - `fontFamily` string
    - `color` string
    - `backgroundColor` string
  - `secondaryButtons` Def9
    - `fontFamily` string
    - `color` string
    - `backgroundColor` string
  - `gpcSignalBanner` Def9
    - `fontFamily` string
    - `color` string
    - `backgroundColor` string
  - `pageBackground` string
  - `published` string
  - `unpublishedPageId` integer
  - `publishedPageId` integer
  - `welcomePageEnabled` boolean
  - `smsVerificationEnabled` boolean
  - `cuiTextCustomizations` Def19[]
    - `title` string
    - `locale` string
    - `gpcBanner` boolean
    - `gpcBannerEnabledText` string
    - `gpcBannerDisabledText` string
    - `welcomeBackTitle` string
    - `welcomeBackDescription` string
    - `signOutLink` string
    - `welcomePage` Def10
      - `title` string
      - `description` string
      - `continueAnonymouslyButton` string
      - `signUpButton` string
      - `verificationFactorInputTitle` string
      - `verificationFactorInputDescription` string
      - `emailSelector` string
      - `phoneSelector` string
      - `emailInputPlaceholder` string
      - `verificationFactorInputSubmitButton` string
    - `signUpPage` Def12
      - `title` string
      - `description` string
      - `cancelButton` string
      - `submitButton` string
      - `emailInputLabel` string
      - `emailInputRequiredText` string
      - `emailInputPlaceholder` string
      - `backButton` string
      - `profileFields` Def11[]
        - `target` string
        - `label` string
        - `placeholder` string
        - `validationRegex` string
        - `fieldType` string
        - `errorMessage` string
      - `emailSelector` string
      - `phoneSelector` string
      - `phoneInputLabel` string
    - `consentsPage` Def13
      - `title` string
      - `submitButton` string
      - `modalTitle` string
      - `modalDescription` string
      - `modalCloseButton` string
      - `modalNextButton` string
      - `modalNextDescription` string
      - `noConsentsTitle` string
      - `noConsentsDescription` string
      - `verificationFactorInputDescription` string
      - `emailInputLabel` string
      - `emailInputPlaceholder` string
      - `verificationFactorInputSubmitButton` string
      - `emailSelector` string
      - `phoneSelector` string
    - `preferencesPage` Def14
      - `title` string
      - `submitButton` string
      - `modalTitle` string
      - `modalDescription` string
      - `modalCloseButton` string
      - `modalNextButton` string
      - `modalNextDescription` string
      - `submitButtonDisabledDescription` string
      - `verificationFactorInputDescription` string
      - `emailInputLabel` string
      - `emailInputPlaceholder` string
      - `verificationFactorInputSubmitButton` string
      - `emailSelector` string
      - `phoneSelector` string
    - `validationModal` Def15
      - `title` string
      - `description` string
      - `disclaimer` string
      - `inputLabel` string
      - `inputPlaceholder` string
      - `submitButton` string
      - `cancelButton` string
    - `smsValidationModal` Def16
      - `title` string
      - `description` string
      - `disclaimer` string
      - `inputLabel` string
      - `inputPlaceholder` string
      - `submitButton` string
      - `cancelButton` string
    - `geolocationModal` Def17
      - `manualTitle` string
      - `manualAgreeLabel` string
      - `manualDropdownPlaceholder` string
      - `manualDropdownLabel` string
      - `confirmationTitle` string
      - `confirmationDescriptionKnown` string
      - `confirmationDescriptionUnknown` string
      - `confirmationDropdownPlaceholder` string
      - `confirmationDropdownLabel` string
      - `confirmationAgreeLabel` string
    - `navigationItems` Def18[]
      - `title` string
      - `route` string
      - `key` string

## Changes

- **2026-06-14** `dedbbc618db6`: 2 info
  - added the optional property `cuiTextCustomizations` to the response with the `200` status
  - added the optional property `smsVerificationEnabled` to the response with the `200` status
- **2024-12-26** `2fe8098661eb`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/osano/apis/unified-consent-core-api/changes/v2/config/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)