Skip to main content
GET
List groups
Returns the organization’s directory groups one page at a time, whether you created them here or your identity provider pushed them through SCIM. Use it to find the group ID you need before you map it to a role or share a workspace with it. Cursor-paginated. Admin or owner.
Availability: Cloud · Enterprise (self-hosted). Not available on the Community edition: a self-hosted deployment needs ENTERPRISE_ENABLED=true, otherwise the endpoint answers 403 with error.type: "enterprise_license_required".

Authorizations

Authorization
string
header
required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Query Parameters

limit
integer
default:50

Page size.

Required range: 1 <= x <= 200
cursor
string

Opaque keyset cursor from the previous page's nextCursor.

q
string

Free-text filter (name or email).

Maximum string length: 200
source
enum<string>
Available options:
manual,
scim

Response

A page of groups

data
object[]
nextCursor
string | null