Logo não encontrada.

API Obter uma Empresa

Estimated reading: 1 minute 234 views

Obter uma empresa única. 

É necessário uso do TOKEN de uma conexão do Super Admin

Endpoint GET
				
					https://Erro: valor 'backendurl' não encontrado./api/companies
				
			

API
Utilize o código em requisições HTTPS com ferramentas como cURL ou bibliotecas de integração.

				
					<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://Erro: valor 'backendurl' não encontrado./api/companies',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_POSTFIELDS =>'{
    "id":"9"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer {seutokenaqui}' //Token cadastrado na conexão
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

Retorno de API (Payload de Resposta)

Exemplo de retorno ao obter uma empresa:

				
					{
  "id": 9,
  "name": "MeuSorteio",
  "phone": "5511999999999",
  "namecomplete": "João da Silva",
  "pais": "BR",
  "indicator": "",
  "email": "joao@meudominio.com.br",
  "status": true,
  "importar": false,
  "logar": true,
  "blockGroups": false,
  "blockRead": false,
  "document": "",
  "dueDate": "2025-11-04T03:00:00.000Z",
  "recurrence": "MENSAL",
  "messageCount": "8384",
  "typebotUrl": "",
  "typebotName": "",
  "iframeUser": "",
  "iframeUserUrl": "",
  "iframeUserB": "",
  "iframeUserUrlB": "",
  "iframeAdmin": "",
  "iframeAdminUrl": "",
  "keystorage": "newmongo",
  "apiUsada": "baileys",
  "useProxy": "noproxy",
  "proxyURL": "",
  "schedules": [],
  "planId": 1,
  "excluded": true,
  "removido": false,
  "createdAt": "2024-11-01T19:58:40.121Z",
  "updatedAt": "2025-03-26T11:49:25.264Z"
}
				
			

Caso sua conexão não seja um Super Admin

				
					{
    "error": "Você não tem permissão para acessar este recurso!"
}
				
			
Tópicos