Skip to main content
GET
List Groups

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

page
integer<int64>
default:1

Page number.

Example:

1

limit
integer<int64>
default:10

Items per page.

Example:

10

name
string

Filter by name (case-insensitive substring).

roleId
string

Filter by role ID (relational listing): only groups the role is granted to.

userId
string

Filter by user ID (relational listing): only groups the user belongs to.

Response

OK

items
object[]

The page of groups.

limit
integer<int64>

The page size that was applied.

Example:

10

page
integer<int64>

The 1-based page this response corresponds to.

Example:

1

total
integer<int64>

Total number of groups, across all pages.

Example:

10