List groups
Retrieves a paginated list of groups. Optional query parameters allow searching, filtering, and sorting the results.
API-KeyX-API-KEY<token>MonoCloud APIs require authentication with an API key. Retrieve your key from the Tenant Settings section of the MonoCloud dashboard and include it in the request header as: X-API-Key: <your_api_key>
The page number to retrieve.
int321 <= value1The number of groups to return per page.
int321 <= value <= 5010Optional Lucene-style filter expression used to search by attributes.
Sort expression in the format field:direction, where direction is 1 for ascending or -1 for descending.
Supported fields include - name, type, clients_assigned, users_assigned, last_assigned, creation_time, last_updated.
Response Headers
200
Returns the x-Pagination header
Number of items returned per page.
int32The current page number.
int32Total number of items available.
int32Indicates whether a previous page exists.
Indicates whether a next page exists.
Response Body
application/json
The groups were retrieved successfully
TypeScript Definitions
Use the response body type in TypeScript.
Returns an array. Each item has the fields below.
Group: Represents a group used to organize users and client assignments.
Errors
curl -X GET "https://your-domain.us.monocloud.com/api/groups?page=1&size=10&filter=%28name%3Aadmin+AND+users_assigned%3A%5B10+TO+100%5D%29&sort=name%3A1" \ -H "X-API-KEY: <token>"[ { "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f", "type": "custom", "name": "string", "description": null, "is_auto_assigned": true, "users_assigned": 0, "clients_assigned": 0, "creation_time": 0, "last_updated": 0, "last_assigned": 0 }]