List Group Members

This API returns the members of a specific group along with their permissions, identified by the group ID.

Endpoint Details

URL	/v1/auth/groups/id/members
Method	GET
Authorization	Bearer Token

---

Request Headers

Header	Type	Description
Content-Type	String	Must be application/json

---

Request Path

To retrieve the members of a specific group, use the following request format:

/v1/auth/groups/5ff4e1da-3d8d-4fde-9d01-52bde2b3bd3f/members

---

Path Parameter

Parameter	Type	Description
id	UUID	Unique identifier of the group

---

Response

Here is an example response after the request has been successfully processed:

Response

{
    "group_permissions": [
        {
            "id": "f682c724-c18d-4fb8-8dde-1ce95b3dfb57",
            "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
            "group_id": "5ff4e1da-3d8d-4fde-9d01-52bde2b3bd3f",
            "user_id": "414a45e9-f194-4a8a-9876-97abb990d4d9",
            "permission_type": "ADMIN",
            "created_by": "414a45e9-f194-4a8a-9876-97abb990d4d9",
            "created_at": 1778763626
        },
        {
            "id": "e88f70d8-05d0-4b87-9319-b7b30eb5ca1d",
            "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
            "group_id": "5ff4e1da-3d8d-4fde-9d01-52bde2b3bd3f",
            "user_id": "7c6126c9-9bc3-4d05-9796-c3c1a7173de2",
            "permission_id": "33f1fbf4-0d36-4bec-a31a-32bbf4404bb8",
            "permission_type": "CUSTOM",
            "created_by": "0a11c692-b992-4d02-8a55-22b005459c50",
            "created_at": 1783580247
        },
        {
            "id": "aad56b5c-9900-40bf-b2cb-2c593f16e944",
            "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
            "group_id": "5ff4e1da-3d8d-4fde-9d01-52bde2b3bd3f",
            "user_id": "c777977b-7a32-4040-b7b0-ee51721433fd",
            "permission_id": "fb5f82f5-78d0-4189-884a-dd23c2e0df84",
            "permission_type": "CUSTOM",
            "created_by": "414a45e9-f194-4a8a-9876-97abb990d4d9",
            "created_at": 1780039806
        },
        {
            "id": "2d1552da-fa94-4ca5-8370-28d86d8c124c",
            "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
            "group_id": "5ff4e1da-3d8d-4fde-9d01-52bde2b3bd3f",
            "user_id": "d7cdf0a4-ffbf-47be-987d-5b3c3ce9cf73",
            "permission_type": "VIEWER",
            "created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
            "created_at": 1784090622
        }
    ],
    "pagination": {
        "total": 4
    }
}

---

Field Descriptions

Field	Type	Description
group_permissions	Array	List of members and their permissions within the group
id	UUID	Unique identifier of the group permission
tenant_id	UUID	Identifier of the tenant that owns the group permission
group_id	UUID	Identifier of the group
user_id	UUID	Identifier of the member user
permission_id	UUID	Identifier of the permission granted to the member
permission_type	String	Type of the permission
created_by	UUID	Identifier of the user who added the member
created_at	Integer	Creation timestamp in Unix format
total	Integer	Total number of members in the group

---

info

• A valid Bearer Token is required to access this endpoint.
• The id path parameter must reference an existing group.
• The permission_type indicates the level of access granted to the member.
• The permission_id field may not be present for members whose permission_type is ADMIN and VIEWER.
• Unix timestamp fields can be converted to a human-readable date and time format as needed.