Skip to main content
GET
List user groups

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

category
enum<string>

Filter by group category.

Available options:
company,
custom
name
string

Filter by group name (case-insensitive contains).

ordering
enum<string>

Order the results by name, created_at or updated_at. Prefix the field with - for descending order (e.g. -created_at). Defaults to name; entries sharing a name are ordered newest-first.

Available options:
-created_at,
-name,
-updated_at,
created_at,
name,
updated_at
page
integer

A page number within the paginated result set.

page_size
integer

The number of results to return per page (default: 20, max: 100).

user_role
enum<string>

Filter by the role of the authenticated user in the group.

Available options:
member,
owner

Response

count
integer
required
Example:

123

results
object[]
required
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"