---
title: "Get List of Geolocation Rule Groups"
method: GET
path: "/api/cmp/v1/georulegroups"
tags: ["Geolocation Rules"]
---

# Get List of Geolocation Rule Groups

`GET /api/cmp/v1/georulegroups`

## Request

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

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

## Query parameters

- `searchStr` string
- `sortBy` 'geoRuleGroupName' | 'status' | 'version'
- `direction` 'asc' | 'desc'
- `page` integer
- `size` integer

## Response `200`

OK

- PageGeoRuleGroupDto
  - `totalPages` integer
  - `totalElements` integer
  - `size` integer
  - `content` GeoRuleGroupDto[]
    - `geoRuleGroupId` string, uuid: Unique identifier of the geo rule group.
    - `geoRuleGroupName` string: Name of the geo rule group.
    - `geoRules` GeoRuleDto[]: List of geo rules within this group.
      - `geoRuleId` string, uuid: Unique identifier of the geo rule.
      - `geoRuleName` string: Name of the geo rule.
      - `consentModel` string: Consent model applied to 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.
    - `isUniversalDefault` boolean: Indicates if the template is the universal default template
    - `isOrgDefault` boolean: Indicates if the template is the default template for the organization
    - `orgDefaultEnabled` boolean: Indicates if the organization default is enabled
    - `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
  - `number` integer
  - `sort` SortObject
    - `empty` boolean: This flag indicates whether the result set is empty.
    - `sorted` boolean: This flag indicates whether the results are sorted.
    - `unsorted` boolean: This flag indicates whether the results are in unsorted order.
  - `pageable` PageableObject
    - `offset` integer: The starting position for paginated results.
    - `sort` SortObject
      - `empty` boolean: This flag indicates whether the result set is empty.
      - `sorted` boolean: This flag indicates whether the results are sorted.
      - `unsorted` boolean: This flag indicates whether the results are in unsorted order.
    - `paged` boolean: This flag indicates whether pagination is enabled.
    - `pageSize` integer: The number of items displayed per page.
    - `pageNumber` integer: The current page number in the pagination sequence.
    - `unpaged` boolean: This flag indicates whether pagination is disabled.
  - `first` boolean
  - `last` boolean
  - `numberOfElements` integer
  - `empty` 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)