Get all groups
GET
/api/groups
Retrieves a paginated list of groups. The endpoint allows you to specify optional search parameters to filter and refine the results.
Query Parameters
page
number
The page number to retrieve.
Default: 1
size
number
The number of items per page.
Default: 10
filter
string
A query filter to apply when searching for groups.
sort
string
Specifies the sort criteria in the 'sort_key:sort_order' format. The sort order value can be '1' for ascending and '-1' for descending. Acceptable sort key values are 'name', 'type', 'clients_assigned', 'users_assigned', 'last_assigned', 'creation_time', and 'last_updated'.
Authentication
X-API-KEY
header
Required
The API key is essential for accessing MonoCloud's APIs. You can find it in the Tenant Settings section of your MonoCloud dashboard. To authenticate your requests, include this key in the request header using the following format: X-API-Key: <Your_API_Key>.
Headers
accept
string
- application/json
- application/problem+json
Responses
200
Successfully retrieved groups
400
Bad Request
401
Unauthorized
403
Forbidden
Request Example
Request
curl -X GET "https://<your-domain>/api/groups?page=1&size=10&filter=admin&sort=name:1" \
-H "X-API-KEY: <your-api-key>" \
-H "Accept: application/json"
Response Example
Response
200 OK
[
{
"creation_time": 1640975500,
"last_updated": 1640975500,
"is_auto_assigned": false,
"last_assigned": 1640975500,
"group_id": "888ac2a4-b6b0-45c4-9920-93c0bc9b2c39",
"clients_assigned": 10,
"name": "Administrators",
"users_assigned": 10,
"description": "The administrator group",
"type": "custom"
}
]