Skip to main content
GET
/
users
Listar Usuarios
curl --request GET \
  --url https://api.example.com/users \
  --header 'Authorization: <authorization>'
{
  "data": [
    {
      "userId": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "externalRef": "auth_ext_abc123",
      "email": "john@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "locale": "en-US",
      "lastSignInAt": "2026-03-25T10:00:00.000Z",
      "emailVerified": true,
      "createdAt": "2026-01-15T10:00:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 10,
    "totalItems": 150,
    "totalPages": 15
  }
}
Retorna uma lista paginada de todos os usuarios.
Requer permissao users:read.

Headers

Authorization
string
required
Bearer token.

Parametros de Query

page
integer
Numero da pagina.
limit
integer
Resultados por pagina.
Buscar por email, primeiro nome ou sobrenome.
sort
string
Campo e direcao de ordenacao (ex: createdAt:desc).

Resposta

{
  "data": [
    {
      "userId": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "externalRef": "auth_ext_abc123",
      "email": "john@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "locale": "en-US",
      "lastSignInAt": "2026-03-25T10:00:00.000Z",
      "emailVerified": true,
      "createdAt": "2026-01-15T10:00:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 10,
    "totalItems": 150,
    "totalPages": 15
  }
}

Exemplos de Codigo

curl https://api.awsales.io/admin/users?page=1&limit=20 \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
500internal_server_errorOcorreu um erro inesperado