Skip to main content
GET
/
v1
/
groups
List Groups
curl --request GET \
  --url https://identity.sandbox.lerian.net/v1/groups \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "createdAt": "2025-04-08T08:01:30.169Z",
      "id": "midaz-viewer-group",
      "name": "Midaz Viewer",
      "users": [
        "johndoe",
        "janedoe"
      ]
    },
    {
      "createdAt": "2025-04-07T18:57:57.312Z",
      "id": "midaz-editor-group",
      "name": "Midaz Editor",
      "users": [
        "johnsmith"
      ]
    }
  ],
  "page": 1,
  "limit": 10,
  "total": 2
}

Authorizations

​
Authorization
string
header
required

The authorization token in the 'Bearer ' format.

Query Parameters

​
page
integer
default:1

The page number to retrieve.

Required range: x >= 1
​
limit
integer
default:10

The maximum number of items to return per page. Cannot exceed 100.

Required range: 1 <= x <= 100

Response

The list of all predefined groups available in the system.

Standard paginated response wrapper.

​
items
object[]

The list of items returned for the current page.

​
page
integer

The current page number.

Example:

1

​
limit
integer

The maximum number of items returned per page.

Example:

10

​
total
integer

The total number of items available across all pages.

Example:

2