Quem é esta chave

GET/v1/me

Devolve a chave que fez a chamada (id, nome, escopos, modo, origem, números e, numa chave de assistente, os tetos), a organização e o que o plano libera. Aceita QUALQUER escopo: é o teste de credencial do SDK, do n8n e do MCP.

Não traz o nome da organização.

Requer#

Escopo da chave: NenhumComo os escopos funcionam
Recurso do plano: API e webhooks apiVer os planos que incluem
Formato: Rota do Synergy. Erros no formato da Meta.

Parâmetros#

Cabeçalhos#

Cabeçalhos
Nome	Tipo	Obrigatório	Descrição
Authorization	string	obrigatório	Sua chave de API, no formato `Bearer <chave>`. Veja Autenticação.

Respostas#

Respostas
Status	Código	Quando acontece
200	—	Chave de uma integração
401	—	Chave revogada ou desconhecida
401	190	Chave malformada ou forjada
403	—	O plano da organização não inclui a API
429	—	Limite de taxa

Os erros no formato da Meta trazem o código em error.code. Ver todos os erros.

Corpo da resposta 200#

Campos da resposta 200
Nome	Tipo	Obrigatório	Descrição
key	object	obrigatório
key.id	string	obrigatório
key.name	string	obrigatório
key.last4	string	obrigatório	Os 4 últimos caracteres da chave.
key.scopes	string[]	obrigatório	Valores: `messages`, `management`, `read`, `onboarding`.
key.mode	string	obrigatório	Valores: `notify`, `bot`.
key.origin	string	obrigatório	`mcp` = criada por uma conexão de assistente ou como "chave para assistente". Valores: `manual`, `mcp`.
key.instance_ids	string[] \| null	obrigatório	Os números que a chave alcança; `null` = todos.
key.assistant	object \| null	obrigatório
organization	object	obrigatório
organization.id	string	obrigatório
plan	object	obrigatório
plan.api	boolean	obrigatório
plan.inbox	boolean	obrigatório	Sem ela, as leituras de conversas e o handoff são recusados.
plan.wa_flows	boolean	obrigatório
plan.mode	string	obrigatório	`readonly`/`suspended`: a conta está com pagamento pendente; envios param. Valores: `normal`, `readonly`, `suspended`.

Limites de taxa#

Organização: 120 requisições a cada 60 s por chave (API_ORG_LIMIT).

Notas#

x-scopes vazio = qualquer escopo serve.
As rotas da organização respondem no formato da gestão ({ "error": … }, com reason ou feature quando há), não no da Graph API — exceto a chave malformada (401, código 190).
Uma chave recusada (revogada, ou sem o escopo) recebe este 401 pelos 60 s seguintes, por instância do Worker (cache de recusa, como na gestão).

Requisição

curl

curl 'https://api.synergyconnect.com.br/v1/me' \
  -H "Authorization: Bearer $SYNERGY_API_KEY"

JavaScript

const res = await fetch('https://api.synergyconnect.com.br/v1/me', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SYNERGY_API_KEY}`,
  },
});
console.log(res.status, await res.json());

Python

import os

import requests

res = requests.get(
    "https://api.synergyconnect.com.br/v1/me",
    headers={
        "Authorization": f"Bearer {os.environ['SYNERGY_API_KEY']}",
    },
)
print(res.status_code, res.json())

Resposta

200

{
  "key": {
    "id": "0b9c4d1e-52a7-4f6b-8c3d-1e2f3a4b5c6d",
    "name": "Integração do ERP",
    "last4": "x9Qa",
    "scopes": [
      "messages",
      "read"
    ],
    "mode": "notify",
    "origin": "manual",
    "instance_ids": null,
    "assistant": null
  },
  "organization": {
    "id": "org_7Hk2pQ9"
  },
  "plan": {
    "api": true,
    "inbox": true,
    "wa_flows": false,
    "mode": "normal"
  }
}

401

{
  "error": "Invalid or revoked key"
}

Há 2 casos com este status; veja a tabela de respostas.

403

{
  "error": "This plan does not include the API",
  "feature": "api"
}

429

{
  "error": "Rate limit hit"
}

Ficou com dúvida? Escreva para suporte@synergyconnect.com.br.