User
Find users
Find users by query filters.
- Retrieve users based on query parameters.
- Recuperar usuários com base em parâmetros de consulta.
get/users
Query parameters
namestring
- Valid email
- Email válido
emailstring
- Email of the user (must be a valid email)
- E-mail do usuário (deve ser um e-mail válido)
rolestring
- Role of the user (e.g., MASTER, OPERATOR)
- Função do usuário (e.g., MASTER, OPERATOR)
tax_numberstring
- Tax number of the user
- Número de documento do usuário
phonestring
- Phone number of the user
- Número de telefone do usuário
blocked_atboolean
- Filter users who are blocked (true/false)
- Filtrar usuários bloqueados (true/false)
created_greater_or_equal_thanstring
- Created date greater or equal to (YYYY-MM-DD)
- Data de criação maior ou igual a (YYYY-MM-DD)
created_less_or_equal_thanstring
- Created date less or equal to (YYYY-MM-DD)
- Data de criação menor ou igual a (YYYY-MM-DD)
company_idinteger
- Company ID associated with the user
- ID da empresa associado ao usuário
limitinteger
- Limit of objects in a page of the pagination
- Limite de objeto em uma página da paginação
pageinteger
- Page of the pagination, return the amount of objects that was set in the limit
- Página da paginação, retorna o total de objetos setado no limite
Response
List of users matching the filters | Lista de usuários que correspondem aos filtros
Example response
{
"limit": 10,
"page": 1,
"rows": [
{
"blocked_at": "null",
"company_id": 1,
"created_at": "2024-09-06T17:37:43.464658136Z",
"email": "john.doe@example.com",
"id": 1,
"language": "portuguese",
"name": "John Doe",
"phone": "(11)99999-9999",
"role": "MASTER",
"tax_number": "123.456.789-01",
"timezone": "UTC-3",
"updated_at": "2024-09-06T17:37:43.464658136Z"
}
],
"sort": "created_at desc",
"total_pages": 1,
"total_rows": 1
}