Skip to main content
GET
/
api
/
v1
/
groups
/
{group_name}
/
members
List group members
curl --request GET \
  --url https://services.pref.rio/heimdall-admin/api/v1/groups/{group_name}/members \
  --header 'Authorization: Bearer <token>'
[
  {
    "subject": "12345678901",
    "display_name": "João Silva",
    "joined_at": "2024-01-15T10:30:00Z",
    "added_by": "98765432109"
  },
  {
    "subject": "23456789012",
    "display_name": "Maria Santos",
    "joined_at": "2024-01-10T09:15:00Z",
    "added_by": "98765432109"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
group_name
string
required

Response

List of group members retrieved successfully

​
subject
string
required

User's CPF (Brazilian tax ID)

Example:

"12345678901"

​
joined_at
string
required

ISO timestamp when the user joined the group

Example:

"2024-01-15T10:30:00Z"

​
display_name
string | null

User's display name if available

Example:

"João Silva"

​
added_by
string | null

CPF of the user who added this member

Example:

"98765432109"