Skip to main content
GET
Get groups

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

cursor
string

The pagination cursor value.

page_size
integer

Number of results to return per page. Default is 200.

Required range: x <= 1000
group_type_filter
enum<string>

The group type to filter by. The type of the group.

Available options:
ACTIVE_DIRECTORY_GROUP,
AWS_SSO_GROUP,
DATABRICKS_ACCOUNT_GROUP,
DUO_GROUP,
GIT_HUB_TEAM,
GIT_LAB_GROUP,
GOOGLE_GROUPS_GROUP,
GOOGLE_GROUPS_GKE_GROUP,
LDAP_GROUP,
OKTA_GROUP,
OKTA_GROUP_RULE,
TAILSCALE_GROUP,
OPAL_GROUP,
OPAL_ACCESS_RULE,
AZURE_AD_SECURITY_GROUP,
AZURE_AD_MICROSOFT_365_GROUP,
CONNECTOR_GROUP,
SNOWFLAKE_ROLE,
WORKDAY_USER_SECURITY_GROUP,
PAGERDUTY_ON_CALL_SCHEDULE,
INCIDENTIO_ON_CALL_SCHEDULE,
ROOTLY_ON_CALL_SCHEDULE,
DEVIN_GROUP,
GIT_HUB_ENTERPRISE_TEAM,
GRAFANA_TEAM,
CLICKHOUSE_ROLE,
SLACK_USER_GROUP,
TWINGATE_GROUP,
TWINGATE_GROUP_SYNCED,
ZENDESK_GROUP,
ZENDESK_ORGANIZATION,
HUBSPOT_TEAM,
TABLEAU_GROUP,
CONFLUENCE_GROUP,
JIRA_GROUP,
DOCUSIGN_GROUP,
ZOOM_GROUP,
LINEAR_TEAM,
RAMP_DEPARTMENT,
RAMP_LOCATION
Example:

"OPAL_GROUP"

group_ids
string<uuid>[]

The group ids to filter by.

group_name
string

Group name.

tag_ids
string<uuid>[]

The IDs of the tags to filter by. Returns only groups that have any of these tags applied.

requestable
boolean

If true, only return groups that allow access requests. Does not check whether the caller is permitted to request the group.

Response

200 - application/json

One page worth groups associated with your organization.

results
object[]
required
next
string | null

The cursor with which to continue pagination if additional result pages exist.

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

previous
string | null

The cursor used to obtain the current result page.

Example:

"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ"

Last modified on September 16, 2026