Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Geolocation Rules

Get Geolocation Rule Group

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.

get/api/cmp/v1/georulegroups/{geoRuleGroupId}

Path parameters

geoRuleGroupIdstring uuid required

Unique identifier of the geo rule group

Response

OK

geoRuleGroupIdstring uuid

Unique identifier of the geo rule group.

geoRuleGroupNamestring

Name of the geo rule group.

defaultConsentModelstring

Default consent model for the geo rule group.

associatedDomainsobject

Map of domain IDs to domain URLs associated with this geo rule group.

assignedMobileAppsobject

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.

orgIdstring uuid

Organization ID that owns this geo rule group.

orgNamestring

Organization name

descriptionstring

Description of the geo rule group.

versioninteger

Version number of the geo rule group.

defaultboolean

Example response

{
  "geoRuleGroupId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
  "geoRuleGroupName": "My new Geo Rule Group",
  "geoRules": [
    {
      "geoRuleId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "geoRuleName": "Europe Rule",
      "isDefault": false,
      "isGlobal": false,
      "audienceLogicEnabled": true,
      "showBanner": true,
      "enableGoogleConsent": false,
      "consentModel": "Opt-In",
      "regions": [
        {
          "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
          "name": "Europe"
        }
      ],
      "countries": [
        {
          "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
          "name": "Germany",
          "code": "DE"
        }
      ],
      "states": [
        {
          "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
          "name": "California",
          "code": "CA"
        }
      ],
      "cookieCategories": [
        {
          "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
          "name": "Strictly Necessary",
          "status": "Opt-out",
          "customCategoryName": "C0001",
          "type": "COOKIE",
          "sequence": 1
        }
      ],
      "templateName": "Default Template",
      "templateId": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
    }
  ],
  "defaultConsentModel": "Opt-In",
  "associatedDomains": {
    "f2229953-b4b5-4042-8cb9-b78038cc4c46": "example.com",
    "a1234567-b4b5-4042-8cb9-b78038cc4c47": "test.com"
  },
  "assignedMobileApps": {
    "c3456789-b4b5-4042-8cb9-b78038cc4c48": "MyApp",
    "d4567890-b4b5-4042-8cb9-b78038cc4c49": "TestApp"
  },
  "status": "ACTIVATED",
  "orgId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
  "orgName": "OneTrust",
  "description": "Default Geo Rule Group for all regions",
  "version": 1
}