Trama — Documentación

Uma API REST sobre os dados da sua organização: o que ela alcança, o que deliberadamente não alcança, e onde pegar uma chave.

A API REST da Trama entrega os dados da sua própria operação — oportunidades, clientes, conversas, cotações, catálogo e equipe — de fora do painel. São os mesmos dados que a sua equipe vê, com o mesmo limite de organização.

Está disponível em todos os planos e sem custo extra, o gratuito incluído.

Pegar uma chave

Dois minutos, em Desenvolvedores no painel.

Testar ao vivo

Cada página de endpoint tem um playground: você manda a requisição daqui, com a sua própria chave.

O básico


URL base	`https://api.trama.so`
Versão	Tudo pendura em `/v1`
Formato	JSON na ida e na volta. `Content-Type: application/json` em qualquer requisição com corpo
Autenticação	Uma chave de API da organização, como bearer token — ver Autenticação
Spec	`api.trama.so/v1/openapi.json`, OpenAPI 3.1, gerada a partir do código que serve o tráfego

curl https://api.trama.so/v1/opportunities \
  -H "Authorization: Bearer $TRAMA_API_KEY"

O que dá para fazer hoje

Ler: oportunidades, clientes, conversas e suas transcrições, cotações e seus anexos, produtos do catálogo, integrantes da equipe.

Escrever: clientes (criar, editar, arquivar) e produtos do catálogo (criar, editar, arquivar).

O resto é somente leitura de propósito. Os caminhos que criam uma oportunidade ou movem um cartão são os que o agente e as automações escrevem, e um segundo escritor sem noção do ciclo de qualificação deixaria o quadro fora de sintonia com a conversa. Se você precisa escrever ali, a porta é o servidor MCP, que passa pelo Trama Agent e respeita as mesmas regras do painel.

O que ainda não existe

Vale saber antes de desenhar a sua integração em volta disso:

Não há webhooks. Ninguém te chama: você consulta. O updatedAt de cada recurso e o Retry-After de um 429 são o que torna possível consultar com educação.
Você não pode enviar uma mensagem. Nem por WhatsApp, nem por nenhum canal. Responder a um cliente passa pela Trama.
Não há paginação por cursor. É limit / offset com um total — ver Paginação.

Convenções

Os carimbos de data e hora são ISO 8601 em UTC (2026-08-29T14:03:11.000Z). Datas sem hora (um check-in, por exemplo) são strings AAAA-MM-DD.
Os IDs são strings opacas. Não faça parsing nem assuma um formato.
Os campos opcionais voltam como null, não ausentes. Um campo que está no schema está sempre na resposta.
stage é uma chave, não um título. Cada agência renomeia as colunas do seu quadro, então a chave é o que é estável para ramificar.
Os valores viajam com a moeda ao lado. Nada é normalizado por você.

Cada chave pertence a UMA organização. Nenhuma requisição nomeia uma organização, e nada do que você lê ou escreve sai daquela que emitiu a chave. Se você opera várias, precisa de uma chave por organização.

A API da Trama