Skip to main content
GET
/
api
/
groups
/
{id}
Retrieve group
curl --request GET \
  --url https://api.example.com/api/groups/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "name": "<string>",
  "users": [
    123
  ],
  "permissions": [
    123
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from AWS Cognito or custom authentication service

Path Parameters

​
id
integer
required

A unique integer value identifying this group.

Response

200 - application/json

Successful Response

Group object with all details

​
id
integer
required

Group ID

​
name
string
required

Group name

​
users
integer[]

List of user IDs in this group

​
permissions
integer[]

List of permission IDs for this group

​
created_at
string<date-time>

Group creation timestamp

​
updated_at
string<date-time>

Group last update timestamp