---
title: "Get all groups paginated"
method: GET
path: "/resources/groups/v2"
tags: ["User groups"]
---

# Get all groups paginated

`GET /resources/groups/v2`

## Request

- Base URL: `http://localhost:8181`
- URL: `http://localhost:8181/resources/groups/v2`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/frontegg/apis/entitlements-agent-pdp/docs/resources/groups/v2/get.ts> (a function with typed inputs; its response is checked against the schema)

This route gets all user groups for a tenant.

## Query parameters

- `_groupsRelations` 'roles' | 'users' | 'rolesAndUsers'
- `_limit` number
- `_offset` number
- `_sortBy` 'id' | 'name' | 'createdAt' | 'updatedAt'
- `_order` 'ASC' | 'DESC'

## Response `200`

- GroupResponse
  - `id` string, required
  - `name` string, required
  - `color` string, required
  - `description` string, required
  - `metadata` string, required
  - `roles` RoleDto[], required
    - `id` string, required
    - `vendorId` string, required
    - `tenantId` string, required
    - `key` string, required
    - `name` string, required
    - `description` string, required
    - `isDefault` boolean, required
    - `firstUserRole` boolean, required
    - `level` number, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `users` GroupUserDto[], required
    - `id` string, required
    - `email` string, required
    - `name` string, required
    - `profilePictureUrl` string, required
    - `createdAt` string, date-time, required
    - `activatedForTenant` boolean, required
  - `managedBy` 'frontegg' | 'scim2', required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required

---

[API](https://skmtc.dev/frontegg/apis/entitlements-agent-pdp.md) - [All operations](https://skmtc.dev/frontegg/apis/entitlements-agent-pdp/llms.txt) - [OpenAPI document](https://skmtc.dev/frontegg/apis/entitlements-agent-pdp/revisions/c496ae9e1c3e?raw)