Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Groups

List group users (EAP)

Paginated list of all users in a group.

get/v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}/users

Path parameters

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

env_idstring required

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

group_instance_keystring required

Either the unique id of the resource instance, or the URL-friendly key of the resource instance (i.e: the "slug").

Either the unique id of the resource instance, or the URL-friendly key of the resource instance (i.e: the "slug").

Query parameters

pageinteger

Page number of the results to fetch, starting at 1.

Page number of the results to fetch, starting at 1.

per_pageinteger

The number of results per page (max 100).

The number of results per page (max 100).

Response

Successful Response

total_countinteger required
page_countinteger

Example response

{
  "data": [
    {
      "key": "user@permit.io",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}