v1
latestOpenAPI 3.1.02026-08-041060342.7 KBGET All companies
Através deste endpoint é possível recuperar os dados das subcontas que você criou, incluindo o token de acesso de cada conta.
IMPORTANTE: Caso precise redefinir o token de uma conta (por vazamento ou qualquer outro problema), solicite diretamente ao suporte.
É possível filtrar os resultados utilizando os query params disponíveis listados abaixo.
get/api/companies
Query parameters
idinteger
ID da empresa.
namestring
Nome da empresa.
emailstring
E-mail da empresa.
phonestring
Telefone da empresa.
cnpjstring
CNPJ da empresa.
addressstring
Endereço da empresa.
tokenstring
Token da empresa.
Response
200
Example response
{
"data": [
{
"id": 8037,
"name": "Dr. Zander Moore",
"email": "empresa@gmail.com",
"phone": "11989999999",
"cnpj": "22345678999999",
"address": "685 Williamson Divide\nNorth Delpha, SD 01865-3706",
"mail_host": "smtp.mailtrap.io",
"mail_from": "no-reply@exemplo.com",
"mail_username": "usuario@exemplo.com",
"mail_encryption": "tls",
"mail_port": "587"
}
],
"links": {
"first": "/?page=1",
"last": "/?page=1"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"label": "« Previous"
}
],
"path": "/",
"per_page": "15",
"to": 2,
"total": 2
}
}