---
title: "List Group"
method: GET
path: "/v2/schema/{proj_id}/{env_id}/groups"
tags: ["Groups"]
deprecated: true
---

# List Group

`GET /v2/schema/{proj_id}/{env_id}/groups`

> **Deprecated.**

List all groups.

## Path parameters

- `proj_id` string, required — Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
- `env_id` string, required — Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

## Query parameters

- `tenant` string — The tenant key or id to filter by
- `resource` string — The resource key or id to filter by
- `include_total_count` boolean — Include total count in response(will make the request slower)
- `page` integer — Page number of the results to fetch, starting at 1.
- `per_page` integer — The number of results per page (max 100).
- `search` string — Text search for the object name or key

## Response `200`

Successful Response

- GroupRead[] — List of Groups
  - `assigned_roles` string[] — List of roles that are assigned to this group
  - `users` string[] — List of user ids that are assigned to this group
  - `group_resource_type_key` string — The key of the resource type that the group belongs to.
  - `group_instance_key` string, required — Either the unique id of the resource instance that that the group belongs to, or the URL-friendly key of the <resource_key:resource_instance_key> (i.e: file:my_file)
  - `group_tenant` string, required — The tenant key or id that the group belongs to.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/permit/apis/permit-io-api.md) · [All operations](https://skmtc.net/permit/apis/permit-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/permit/permit-io-api/revisions/2d4b53fdbeb9/schema)