Skip to main content
GET
List the users in a permission group
Returns the members of one group. Everybody listed here holds every grant the group holds.

Response

An array of user objects. This endpoint is not paginated.
Invited people appear here. is_pending: true with is_active: false is somebody who has been invited and has not accepted — they hold the group’s grants already, and accepting is what lets them sign in and use them. See Onboarding flow.
Deactivated members are not listed. They were switched off deliberately, and their access is gone regardless of what group they were in.

Authorizations

x-api-key
string
header
required

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

Path Parameters

permission_group_pk
string<uuid>
required

The permission group's id.

Response

200 - application/json
id
integer
required
read-only
first_name
string
required
read-only
last_name
string
required
read-only
email
string<email>
required
read-only
picture
string<uri> | null
required
read-only
role
string
required
read-only
functional_area
required
  • data_analytics - Data & Analytics
  • sales - Sales
  • customer_support - Customer Support
  • operations - Operations
  • marketing - Marketing
  • finance - Finance
  • product_development - Product Development
  • growth - Growth
  • executive_leadership - Executive Leadership
  • other - Other
Available options:
data_analytics,
sales,
customer_support,
operations,
marketing,
finance,
product_development,
growth,
executive_leadership,
other
other_functional_area
string | null
required
read-only
date_joined
string<date-time>
required
read-only
last_login
string<date-time> | null
required
read-only
is_active
boolean
default:false
required
read-only
is_pending
boolean
default:false
required
read-only