v1

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

Get List of Geolocation Rule Groups

Use this API to retrieve a paginated list of geolocation rule groups. The search parameter can be used to optionally filter results by name.

get/api/cmp/v1/georulegroups

Query parameters

searchStrstring

Search string to filter geo rule groups by name

sortBy'geoRuleGroupName' | 'status' | 'version'

Field to sort by.

direction'asc' | 'desc'

Sort direction.

pageinteger
Example:1

The page number for pagination results, starting from 0.

sizeinteger
Example:10

The number of items to return per page.

Response

OK

totalPagesinteger
totalElementsinteger
sizeinteger
numberinteger
firstboolean
lastboolean
numberOfElementsinteger
emptyboolean

Example response

{
  "content": [
    {
      "geoRuleGroupId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "geoRuleGroupName": "Your New Geo Rule Group",
      "geoRules": [
        {
          "geoRuleId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
          "geoRuleName": "Europe Rule",
          "consentModel": "Opt-In",
          "default": false,
          "global": false
        }
      ],
      "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": "ACTIVE",
      "orgId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "orgName": "OneTrust",
      "description": "Default geo rule group for all regions",
      "version": 1
    }
  ]
}