Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Groups

List Direct Group

Paginated list of groups with various filters.

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

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

Query parameters

tenantstring

The tenant key or id to filter by

The tenant key or id to filter by

resourcestring

The resource key or id to filter by

The resource key or id to filter by

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

searchstring

Text search for the object name or key

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"
    }
  ]
}