---
title: "Get Geolocation Rule Group"
method: GET
path: "/api/cmp/v1/georulegroups/{geoRuleGroupId}"
tags: ["Geolocation Rules"]
---

# Get Geolocation Rule Group

`GET /api/cmp/v1/georulegroups/{geoRuleGroupId}`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/cmp/v1/georulegroups/{geoRuleGroupId}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `COOKIE_READ`

Use this API to retrieve detailed information for all geolocation rules within a specified geolocation rule group, including regions, consent model, cookie categories, and other attributes.

## Path parameters

- `geoRuleGroupId` string, uuid, required

## Response `200`

OK

- GeoRuleGroupDetailDto
  - `geoRuleGroupId` string, uuid: Unique identifier of the geo rule group.
  - `geoRuleGroupName` string: Name of the geo rule group.
  - `geoRules` GeoRuleDetailDto[]: List of geo rules within this group.
    - `geoRuleId` string, uuid: Unique identifier of the geo rule.
    - `geoRuleName` string: Name of the geo rule.
    - `createdDate` string, date-time: Date when the geo rule was created.
    - `audienceLogicEnabled` boolean: Indicates if audience logic is enabled for this geo rule.
    - `showBanner` boolean: Indicates if the consent banner should be displayed.
    - `enableGoogleConsent` boolean: Indicates if Google Consent Mode is enabled.
    - `consentModel` string: Consent model applied to this geo rule.
    - `regions` RegionResponseDto[]: List of regions assigned to this geo rule.
      - `id` string, uuid: Unique identifier of the region.
      - `name` string: Name of the region.
    - `countries` CountryResponseDto[]: List of countries assigned to this geo rule.
      - `id` string, uuid: Unique identifier of the country.
      - `name` string: Name of the country.
      - `code` string: ISO country code.
      - `regionCode` string: ISO region code of the region this country belongs to.
    - `states` StateResponseDto[]: List of states assigned to this geo rule.
      - `id` string, uuid: Unique identifier of the state.
      - `name` string: Name of the state.
      - `code` string: State code.
      - `countryCode` string: ISO country code of the country this state belongs to.
    - `cookieCategories` CookieCategoryDto[]: List of cookie categories and their consent status for this geo rule.
      - `id` string, uuid: Unique identifier of the cookie category.
      - `name` string: Name of the cookie category.
      - `status` string: Consent status for this category.
      - `customCategoryName` string: Custom category name.
      - `customCategoryId` string, uuid: Unique identifier of the custom category.
      - `type` string: Type of the cookie category.
      - `doNotTrackEnabled` boolean: Indicates if Do Not Track is enabled for this category.
      - `globalPrivacyControlEnabled` boolean: Indicates if Global Privacy Control is enabled for this category.
      - `cookiepediaCategoryId` integer: Cookiepedia category ID.
      - `sequence` integer: Sequence of the cookie category.
    - `attributes` object: Map of template attributes for this geo rule.
    - `templateName` string: Name of the template associated with this geo rule.
    - `templateId` string, uuid: Unique identifier of the template associated with this geo rule.
    - `default` boolean
    - `global` boolean
  - `defaultConsentModel` string: Default consent model for the geo rule group.
  - `associatedDomains` object: Map of domain IDs to domain URLs associated with this geo rule group.
  - `assignedMobileApps` object: Map of mobile app IDs to app names assigned to this geo rule group.
  - `status` 'DRAFT' | 'ACTIVATED' | 'PUBLISHED' | 'DISABLED': Current status of the geo rule group.
  - `orgId` string, uuid: Organization ID that owns this geo rule group.
  - `orgName` string: Organization name
  - `description` string: Description of the geo rule group.
  - `version` integer: Version number of the geo rule group.
  - `default` boolean

## 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-cookie-consent.md) - [All operations](https://skmtc.dev/onetrust/apis/consent-preferences-cookie-consent/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/consent-preferences-cookie-consent/revisions/b4fb4606f973?raw)