Reten Docs
Usuários

Listar Usuários do Tenant

Obtenha uma lista paginada de usuários no tenant atual.

GET /api/user/tenant-users

Retorna uma lista paginada dos usuários do tenant ativo, dos mais recentes para os mais antigos.

Auth: Obrigatória — permissão user:view

Headers

HeaderObrigatórioValor
AuthorizationSimBearer <access_token>
x-tenant-idSimUUID do tenant

Parâmetros de Consulta

ParâmetroTipoPadrãoDescrição
pagenumber1Número da página, começando em 1
limitnumber20Itens por página (máximo de 100)
searchstring—Correspondência parcial, sem diferenciar maiúsculas de minúsculas, em firstName, lastName, email ou username
rolestring—Apenas usuários com este valor de função: super_admin, admin, fde, supervisor, operator, viewer
isActiveboolean—true ou false

Exemplo

curl "https://api.reten.ai/api/user/tenant-users?page=1&limit=10" \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>"
const params = new URLSearchParams({ page: "1", limit: "10" });
const response = await fetch(`https://api.reten.ai/api/user/tenant-users?${params}`, {
  headers: {
    "Authorization": "Bearer <token>",
    "x-tenant-id": "<tenant-id>",
  },
});
const data = await response.json();
import requests

response = requests.get(
    "https://api.reten.ai/api/user/tenant-users",
    headers={
        "Authorization": "Bearer <token>",
        "x-tenant-id": "<tenant-id>",
    },
    params={"page": 1, "limit": 10},
)
data = response.json()

Resposta 200 OK

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "firstName": "Jane",
      "lastName": "Doe",
      "username": "jdoe",
      "email": "jdoe@example.com",
      "roles": ["supervisor"],
      "isActive": true,
      "createdAt": "2026-09-28T14:30:00.000Z"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 10,
  "totalPages": 1
}

Com role, o roles de cada usuário lista apenas a função filtrada, mesmo quando o usuário tem outras funções.

Respostas de Erro

StatusDescrição
400Erro de validação — page ou limit fora do intervalo, role não é um valor de função, ou isActive não é true/false
403Falta a permissão — Required permissions: user:view