Skip to main content
GET
List Groups

Authorizations

Authorization
string
header
required

The access_token returned by POST /apikeys/token for an API key's secret.

Query Parameters

page
integer
default:1

Page number, starting from 1

Required range: x >= 1
page_size
integer
default:20

Number of items per page

Required range: 1 <= x <= 100
search
string | null

Search by name or description

ids
string[] | null

Optional group IDs to resolve; bypasses pagination

sort_by
string | null

Optional sort field: name, description, or memberCount

sort_order
string
default:asc

Sort order: asc or desc

Response

Successful Response

items
GroupListItem · object[]
required
meta
PaginationMeta · object
required