Listar Empresas

Lista empresas da matriz e suas filiais. Requer API Key com scope empresas:read. Use header X-Sandbox-Mode: true para acessar dados sandbox.

Autenticação:

🔑 API Key

Respostas

{
  "ok": true,
  "data": [
    {
      "empresa_id": 1,
      "nome_fantasia": "Empresa Matriz",
      "cnpj": "12345678000190",
      "status": "Ativa",
      "empresa_matriz_id": null,
      "is_sandbox": false
    }
  ]
}

Sandbox Mode

curl --request GET \
  'http://localhost:3000/api/v1/empresas' \
  --header 'x-api-key: yk_sua_api_key'

Exemplos de Resposta

{
  "ok": true,
  "data": [
    {
      "empresa_id": 1,
      "nome_fantasia": "Empresa Matriz",
      "cnpj": "12345678000190",
      "status": "Ativa",
      "empresa_matriz_id": null,
      "is_sandbox": false
    }
  ]
}