Consultar organização

Serviço para consultar os dados da sua organização: nome, logotipo, opções de personalização visual (white label) e os webhooks configurados.

GET/companychave públicapuk_

Autenticação

Inclua sua chave pública no cabeçalho Authorization.

Authorization: puk_xxx...

Parâmetros de consulta

Este serviço não recebe parâmetros. A organização é identificada a partir da chave pública enviada no cabeçalho Authorization.

Estrutura da resposta

Campo	Tipo	Descrição
id	String	Identificador da organização.
name	String	Nome da organização.
webhooks	Array	Lista de webhooks configurados. Cada elemento contém id, description, url e header. Veja Webhooks.
uxOptions	Object	Opções de personalização visual (white label), por exemplo primaryColor e alternateColor.
image	String	URL do logotipo da organização.
webhook	String	(Legado) URL do webhook único. Mantido por compatibilidade; use webhooks.
webhookHeader	Object	(Legado) Cabeçalho { key, value } do webhook único. Mantido por compatibilidade; use webhooks.

Campos legados

webhook e webhookHeader são retornados apenas para integrações legadas. A configuração atual de notificações é feita por meio do array webhooks (veja Webhooks).

🧪 Exemplo de uso

Curl

curl -X GET 'https://api.auco.ai/v1.5/ext/company' \
  -H 'Authorization: puk_public_key_company'

Python

import requests

response = requests.get(
  'https://api.auco.ai/v1.5/ext/company',
  headers={'Authorization': 'puk_public_key_company'}
)
print(response.json())

Node.js

const axios = require('axios');

axios
  .get('https://api.auco.ai/v1.5/ext/company', {
    headers: { Authorization: 'puk_public_key_company' }
  })
  .then((response) => console.log(response.data));

📥 Exemplo de resposta

{
  "id": "61ba073970df523d9d232a27",
  "name": "Auco",
  "webhooks": [
    {
      "id": "default",
      "description": "Webhook principal",
      "url": "https://miempresa.com/webhooks/auco",
      "header": {
        "key": "Authorization",
        "value": "Bearer ..."
      }
    }
  ],
  "uxOptions": {
    "primaryColor": "#021C30",
    "alternateColor": "#A557F2"
  },
  "image": "https://static.micontrato.co/companies/61ba073970df523d9d232a27/logo.png",
  "webhook": "",
  "webhookHeader": {}
}

⚠️ Respostas de erro

Código	Descrição
401	Autenticação inválida ou ausente