Skip to content
Deprecated

Get groups matching the given filter criteria.

GET
/backend/v1/groups

Get groups matching the given filter criteria.

Authorizations

HTTPBearer
TypeHTTP (bearer)

Parameters

Query Parameters

search

Group's name for filtering results.

cursor

Selects page for paginated results. Pass in the next or prev attribute in the response

limit

Number of results to return.

Typeinteger
default10
maximum100
minimum1
admin

If true and user is a super admin, filters results to only groups the user is admin of

Responses

Successful Response
application/json
JSON
{
"groups": [
{
"id": "string",
"memberCount": 0,
"name": "string"
}
],
"next": "string",
"prev": "string"
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

Updated at: