Lista usuários com filtros e paginação

GET

/api/v1/users

Lista paginada de usuários cujos parceiros estão na hierarquia do caller.

Filtros

full_name — busca parcial case-insensitive em full_name.

cpf — busca parcial em cpf (apenas dígitos).

email — busca parcial em email/username.

Múltiplos filtros são combinados com AND (todos precisam bater).

Paginação

page — base 0 (a primeira página é page=0).

size — entre 1 e 100 (valores acima são capados em 100).

Ordenação (parâmetro `sort`)

Formato campo,direcao, repetível para ordenar por múltiplos campos:

GET /api/v1/users?sort=created_at,desc
GET /api/v1/users?sort=full_name,asc&sort=created_at,desc

campo — nome do field em snake_case (created_at, full_name, cpf, email, …).

direcao — asc ou desc. Default quando omitido: asc.

Default geral quando sort não é informado: created_at,desc.

Requisição

Authorization

JWT Bearer

Adicionar o parâmetro

Authorization

a Cabeçalhos

Exemplo:

Authorization: ********************

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200

application/json

Página de usuários.

Bodyapplication/json

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://gtw.unnotech.com.br/public/api/v1/users?page=0&size=20&full_name=fulano&cpf=12345&email=fulano%40&sort=full_name%2Casc' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Exemplo 1

{
    "content": [
        {
            "user_id": "5605a9a6-b23b-47b8-8e33-548f66984670",
            "name": "Suellen Aparecida",
            "email": "suellenarruda12@gmail.com",
            "phone": "11987654321",
            "cpf": "12345678901",
            "status": "ACTIVE",
            "group": {
                "slug": "gerente-corban",
                "label": "GERENTE CORBAN",
                "group_id": "c57d9d45-552c-4c02-870e-f086cb09c57d"
            },
            "must_change_password": true,
            "created_at": "2026-05-08T13:45:00.000Z",
            "partner_id": "a52a555d-68f8-4560-b544-8ebc76a447ac"
        }
    ],
    "page": {
        "number": 0,
        "size": 20,
        "total_elements": 142,
        "total_pages": 8
    },
    "sort": [
        {
            "property": "created_at",
            "direction": "asc"
        }
    ]
}

Modificado em 2026-07-28 02:36:49

Página anterior

Guia: Originação FGTS

Próxima página

Cadastra um novo usuário

Lista usuários com filtros e paginação

Filtros#

Paginação#

Ordenação (parâmetro sort)#

Requisição

Respostas

Filtros

Paginação

Ordenação (parâmetro `sort`)