List Users

Retrieves all Users with pagination.

GET /v1/users

Error

A valid request URL is required to generate request examples

200

{
  "Pagination": {
    "total": 10,
    "limit": 10,
    "page": 1,
    "items": "{}"
  },
  "items": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "phone": 5511998888777,
      "countryCode": "BR",
      "groups": [
        "groups",
        "groups"
      ],
      "mfa": "{}",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "email": "[e-mail]",
      "username": "johndoe"
    },
    {
      "firstName": "John",
      "lastName": "Doe",
      "phone": 5511998888777,
      "countryCode": "BR",
      "groups": [
        "groups",
        "groups"
      ],
      "mfa": "{}",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "email": "[e-mail]",
      "username": "johndoe"
    }
  ]
}

Autorizaciones

Authorization · string · header · requerido

Bearer authentication. Send Authorization: Bearer .

Parámetros de consulta

page · integer · predeterminado: 1

Page number

limit · integer · predeterminado: 10

Items per page

name · string

Filter by name (case-insensitive substring)

roleId · string

Filter by role ID (relational listing)

groupId · string

Filter by group ID (relational listing)

Respuesta

200

application/json

OK

Pagination · object

Pagination is the struct designed to store the pagination data of an entity list.

Show child attributes

Ejemplo:

{
  "total": 10,
  "limit": 10,
  "page": 1,
  "items": "{}"
}

items · object[]

Show child attributes