Find users

Find users by query filters.

  • Retrieve users based on query parameters.
    • Recuperar usuários com base em parâmetros de consulta.
Query Params
string
Defaults to "John Doe"
  • Valid email
    • Email válido
string
Defaults to "[email protected]"
  • Email of the user (must be a valid email)
    • E-mail do usuário (deve ser um e-mail válido)
string
Defaults to "MASTER"
  • Role of the user (e.g., MASTER, OPERATOR)
    • Função do usuário (e.g., MASTER, OPERATOR)
string
Defaults to "123.456.789-00"
  • Tax number of the user
    • Número de documento do usuário
string
Defaults to "11999999999"
  • Phone number of the user
    • Número de telefone do usuário
boolean
Defaults to true
  • Filter users who are blocked (true/false)
    • Filtrar usuários bloqueados (true/false)
string
Defaults to "2024-01-01"
  • Created date greater or equal to (YYYY-MM-DD)
    • Data de criação maior ou igual a (YYYY-MM-DD)
string
Defaults to "2024-12-31"
  • Created date less or equal to (YYYY-MM-DD)
    • Data de criação menor ou igual a (YYYY-MM-DD)
integer
Defaults to 123
  • Company ID associated with the user
    • ID da empresa associado ao usuário
integer
Defaults to 10
  • Limit of objects in a page of the pagination
    • Limite de objeto em uma página da paginação
integer
Defaults to 1
  • 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
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json