Sign inSign up

Get a group

GET
/api/groups/[group_id]
Retrieves details about a specific group using its ID.

Path Parameters

group_id
string
Required

The ID of the group to retrieve.

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 the group
422
Client Error
404
Not Found
401
Unauthorized
403
Forbidden

Request Example

Request
curl -X GET "https://<your-domain>/api/groups/{group_id}" \
 -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"
}