---
title: "Get Priority Scores for Purpose Statuses"
method: GET
path: "/api/consent/v2/consent-groups/settings"
tags: ["Consent Groups"]
---

# Get Priority Scores for Purpose Statuses

`GET /api/consent/v2/consent-groups/settings`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/consent/v2/consent-groups/settings`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `CONSENT`, `CONSENT_READ`

Use this API to retrieve the Priority Scores for each Purpose Status.

> 🗒 Things to Know
> 
> - All Purpose Statuses are given a Priority Score. A Purpose Status with a lower Priority Score will be given precedence over a Purpose Status with a higher Priority Score.
> - Each Purpose in a Consent Group has its own Purpose Rule which is comprised of an Enforced Status and Effective Status.
> - The Enforced Status is the Purpose Status that you want to apply for a particular Purpose.
> - The Effective Status is calculated using the Priority Scores across the entire Consent Group hierarchy for each Purpose.

> 👍 
> 
> For more information, see [Using Consent Groups to Alter a Data Subject's Consent Status](https://developer.onetrust.com/onetrust/docs/using-consent-groups-to-alter-a-data-subjects-consent-status).

## Response `200`

Successfully retrieved Consent Group settings.

- ConsentAPIConsentGroupSettingsDto
  - `statusPriorityRules` ConsentAPIConsentGroupStatusPriorityDto[], required: The Priority of the Purpose Statuses in the context of Consent Groups
    - `status` 'ACTIVE' | 'ALWAYS' | 'ACTIVE' | 'OPT OUT' | 'HARD OPT OUT' | 'PENDING' | 'NO CONSENT' | 'WITHDRAWN' | 'EXPIRED': The Purpose Status value
    - `priority` integer, required: The Priority of the Purpose Status, with 0 being the highest possible value

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500`: Internal Server Error

---

[API](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management.md) - [All operations](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management/revisions/fe4a0697ec9d?raw)