Skip to main content
GET
/
api
/
v1
/
groups
/
List all groups
curl --request GET \
  --url https://services.pref.rio/heimdall-admin/api/v1/groups/ \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 1,
    "name": "engineering_team:backend",
    "description": "Engineering team with access to development resources",
    "created_by": "12345678901",
    "created_at": "2024-01-15T10:30:00Z"
  },
  {
    "id": 2,
    "name": "marketing_team:frontend",
    "description": "Marketing team for campaign management",
    "created_by": "98765432109",
    "created_at": "2024-01-16T14:20:00Z"
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
prefix
string | null

Filter groups by name prefix (case-insensitive)

Response

List of groups retrieved successfully

​
id
integer
required

Unique identifier for the group

Example:

1

​
name
string
required

Group name

Example:

"engineering_team:backend"

​
description
string
required

Group description

Example:

"Engineering team with access to development resources"

​
created_at
string
required

ISO timestamp when the group was created

Example:

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

​
created_by
string | null

CPF of the user who created this group

Example:

"12345678901"