Company
Find companies
Find companies by query filters.
- Retrieve companies based on query parameters.
- Recuperar empresas com base em parâmetros de consulta.
get/companies
Query parameters
company_typestring
- Type of the company (e.g., INVESTOR, ACQUIRER, MODERATOR)
- Tipo da empresa (e.g., INVESTIDOR, ADQUIRENTE, MODERADOR)
emailstring
- Email of the company (must be a valid email)
- E-mail da empresa (deve ser um e-mail válido)
namestring
- Valid name
- Nome válido
tax_numberstring
- Tax number of the company
- Número de documento da empresa
phonestring
- Phone number of the company
- Número de telefone da empresa
trade_namestring
- Valid trade name
- Nome fantasia válido
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)
user_idinteger
- User ID associated with the company
- ID do usuário associado a empresa
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": [
{
"bank": "001",
"bank_account": "567890",
"bank_account_digit": "0",
"bank_account_type": "Poupança",
"bank_branch": "1234",
"business_type": "Investor",
"company_type": "INVESTOR",
"created_at": "2020-01-01 12:00:00",
"email": "john.doe@example.com",
"id": 1,
"legal_nature": "Investor",
"name": "Fitbank",
"phone": "(11)99999-9999",
"tax_number": "11.111.111/0001-11",
"trade_name": "Fitbank",
"updated_at": "2020-01-01 12:00:00"
}
],
"sort": "created_at desc",
"total_pages": 1,
"total_rows": 1
}