PEpermit
Groups

List Direct Group

Changed on

Paginated list of groups with various filters.

get/v2/schema/{proj_id}/{env_id}/groups/direct

Request

  • Base URL
    https://api.permit.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

proj_idstring required

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").

Query parameters

tenantstring

The tenant key or id to filter by

resourcestring

The resource key or id to filter by

pageinteger

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

per_pageinteger

The number of results per page (max 100).

searchstring

Text search for the object name or key

Response

Successful Response

total_countinteger required
page_countinteger

Example response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "group_resource_type_key": "company",
      "group_instance_key": "Acme",
      "group_tenant": "business"
    }
  ]
}

Changes