Skip to main content
GET
Retrieve a permission group
Reads a single group. Expanded, this is the fastest way to answer “what does this team have access to”, because a group’s grants are listed on all three axes at once.

Query parameters

Audit a team’s access

The three permission fields list only the grants held directly by the group. A member of the group may reach more than this through their own grants or another group — a person’s effective access is the union of everything that reaches them.

Response

A permission group object.

Errors

Authorizations

x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: api_key'

Path Parameters

id
string<uuid>
required

The permission group's id.

Response

200 - application/json
id
string<uuid>
required
read-only
name
string
required
Maximum string length: 150
all_group
boolean
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
users
integer[]
required

Users (Expandable)

description
string | null