Conta

Dados da chave e da organização

GET/v1/me

Devolve a organização dona da chave, os dados da chave usada na requisição e o estado do limite de requisições. Use para testar se a chave funciona e para saber se ela é somente leitura.

Não tem parâmetros.

curl

curl https://platform.toptalking.com.br/v1/me \
  -H "Authorization: Bearer $TOPTALKING_API_KEY"

JavaScript

const res = await fetch('https://platform.toptalking.com.br/v1/me', {
  headers: { Authorization: `Bearer ${process.env.TOPTALKING_API_KEY}` },
});
const conta = await res.json();
console.log(conta.organization.name, conta.api_key.access);

Python

import os
import requests

res = requests.get(
    "https://platform.toptalking.com.br/v1/me",
    headers={"Authorization": f"Bearer {os.environ['TOPTALKING_API_KEY']}"},
    timeout=30,
)
res.raise_for_status()
conta = res.json()
print(conta["organization"]["name"], conta["api_key"]["access"])

Resposta 200

{
  "object": "account",
  "organization": {
    "id": "e044a615-e879-44bb-8510-948b10b5e93c",
    "name": "Loja Aurora"
  },
  "api_key": {
    "id": "508a23eb-5e24-4997-b928-3fce4f0f5593",
    "name": "Integração do site",
    "prefix": "tt_live_a1b2c3d4",
    "access": "full",
    "created_at": "2026-11-11T13:02:11Z"
  },
  "rate_limit": {
    "limit": 120,
    "remaining": 119,
    "reset_at": "2026-11-11T14:31:00Z"
  }
}

Campo	Tipo	Descrição
object	string	Sempre account.
organization.id	UUID	ID da organização.
organization.name	string	Nome da organização.
api_key.id	UUID	ID da chave.
api_key.name	string	Nome dado à chave no painel.
api_key.prefix	string	Início da chave (ex.: tt_live_a1b2c3d4), para identificar sem expor a chave inteira.
api_key.access	string	full (acesso total) ou read (somente leitura).
api_key.created_at	data	Quando a chave foi criada.
rate_limit.limit	inteiro	Requisições permitidas por minuto (120).
rate_limit.remaining	inteiro	Quantas ainda restam na janela atual.
rate_limit.reset_at	data	Quando a janela reinicia.

Erros

HTTP	code	Quando acontece
401	missing_api_key, invalid_api_key, revoked_api_key, expired_api_key	Problema com a chave. Veja Autenticação.
429	rate_limit_exceeded	Limite de requisições excedido.

401 invalid_api_key

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_api_key",
    "message": "Chave de API inválida.",
    "request_id": "req_6f1d2c3b4a5e"
  }
}