API Reference
Start typing to search…

Returns a list of the groups on the platform.

get
http://localhost/api/v1/groups

Note that only the groups the user is a member of will be returned. Only global admin users can see the full list of groups.

Required permissions

  • read groups

Optional permissions

  • read users Required to access the list of users on a group (alternatively, you can only see users for the groups you administer)
Query Params
int32
≥ 1

Maximum number of items to be returned

int32
≥ 0

Return results starting from the specified (zero-based) index

string

Comma-separated list of fields to sort on. Prefix a field with the minus "-" sign if you intend to apply descending sorting to it

boolean

Set this parameter to false if you want to only retrieve the number of objects matching the query

string

Comma-separated list of attributes to be returned. Nested attributes are separated by dots - e.g. data.title

string

Filter by group name

Responses

Updated 11 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 11 months ago