GET /api/usergroups/:id
Show a user group

Examples

GET /api/usergroups/5-usergroup325
200
{
  "admin": false,
  "created_at": "2020-05-20 13:36:08 UTC",
  "updated_at": "2020-05-20 13:36:08 UTC",
  "name": "usergroup325",
  "id": 5,
  "external_usergroups": [],
  "usergroups": [],
  "users": [],
  "roles": []
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.