Find companies

Find companies by query filters.

  • Retrieve companies based on query parameters.
    • Recuperar empresas com base em parâmetros de consulta.
Query Params
string
Defaults to "INVESTOR"
  • Type of the company (e.g., INVESTOR, ACQUIRER, MODERATOR)
    • Tipo da empresa (e.g., INVESTIDOR, ADQUIRENTE, MODERADOR)
string
Defaults to "[email protected]"
  • Email of the company (must be a valid email)
    • E-mail da empresa (deve ser um e-mail válido)
string
Defaults to "Fitbank"
  • Valid name
    • Nome válido
string
Defaults to "11.111.111/0001-11"
  • Tax number of the company
    • Número de documento da empresa
string
Defaults to "11999999999"
  • Phone number of the company
    • Número de telefone da empresa
string
Defaults to "Fitbank"
  • Valid trade name
    • Nome fantasia válido
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
  • User ID associated with the company
    • ID do usuário associado a empresa
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
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json