Skip to main content
GET
List groups
Archived groups are not listed; you can still get one by its ID.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization whose groups you want to list.

Format: UUID

Query Parameters

name
string

Only groups whose name contains this text (case-insensitive).

Maximum string length: 80
next
string

Cursor returned as next by the previous page. Omit for the first page.

limit
integer
default:15

Page size.

Required range: 1 <= x <= 100

Response

Successful response

A page of groups.

next
string | null
required

Cursor for the next page: send it as the next query parameter. null on the last page.

Example:

"NmEzZjljMjFlNGIwN2Q1YThjMTJmM2U5"

items
object[]
required

The groups on this page, sorted by name.