Skip to content

View one group

Request:

GET /api/v2/groups/<group-id>.json

Example of response:

{
    "group": {
        "group_id": "546340bf-8b47-21e4-95a4-e03f497dbd55",
        "tenant_id": "156340bf-8b47-21e4-95a4-e03f497dbd44",
        "name": "Sales Department",
        "timezone": null
    }
}

See Group object fields.

Response contains HTTP status code as shown in the following table.

Response Description
200 OK The group is returned in the response body
403 Forbidden The request cannot be completed because API user has no permission to view groups
404 Not Found Group with such ID does not exist, or it is outside the access scope of the API user