Mentorian Enterprise

Public API v2

Referência para conectar um sistema externo aos dados públicos de um workspace Mentorian, sem utilizar rotas internas do App.

OpenAPI 3.1Base URL: https://api.mentorian.com.br

Quickstart

  1. 1. O owner abre API e integrações no menu da conta.
  2. 2. Cria uma chave com apenas os escopos necessários.
  3. 3. Copia o segredo exibido uma única vez.
  4. 4. Guarda a chave no servidor ou gerenciador de segredos.
curl https://api.mentorian.com.br/v2/workspace \
  -H "Authorization: Bearer mnt_live_SEU_IDENTIFICADOR.SEU_SEGREDO"

Autenticação

Envie a chave no header Authorization: Bearer. Cada chave pertence a um único workspace, tem expiração, escopos, limite e trilha de uso próprios.

Não coloque a chave em JavaScript do navegador, aplicativo móvel, repositório, planilha ou conversa. Use uma chave diferente para produção, homologação e cada integração.

Recursos e escopos

Workspace

workspace:read

Identidade, status e fuso horário do workspace autenticado.

GET /v2/workspace

Contatos e funil

contacts:read · contacts:write

Entrada de leads, sincronização incremental e upsert por ID externo.

GET /v2/contactsPOST /v2/contactsGET /v2/contacts/{id}PATCH /v2/contacts/{id}PUT /v2/contacts/external/{external_id}GET /v2/pipeline/stages

Agendamentos

appointments:read

Consulta de agenda. Escrita continua fora até garantir efeitos transacionais de calendário.

GET /v2/appointmentsGET /v2/appointments/{id}

Catálogo comercial

catalog:read

Produtos e serviços públicos, sem notas comerciais privadas ou metadata interna.

GET /v2/catalog/itemsGET /v2/catalog/items/{id}

Conversas e mensagens

conversations:read · messages:read

Mensagens é um escopo sensível. Payloads e identificadores do provedor não são expostos.

GET /v2/conversationsGET /v2/conversations/{contact_id}/messages

Automações e eventos

automations:read · events:read

Resumos operacionais e feed de mudanças, sem condições, ações ou logs internos.

GET /v2/automationsGET /v2/automations/{id}GET /v2/events

Paginação e idempotência

Listas usam limit de 1 a 100 e um cursor opaco. Use updated_after para sincronização incremental; mensagens usam created_after.

Escritas de contatos exigem Content-Type: application/json e Idempotency-Key. A mesma chave com corpo diferente retorna 409; o replay fica disponível por 48 horas.

curl -X POST https://api.mentorian.com.br/v2/contacts \
  -H "Authorization: Bearer mnt_live_SEU_IDENTIFICADOR.SEU_SEGREDO" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: lead-2026-0001" \
  -d '{"name":"Ana Silva","email":"ana@example.com","status":"talking"}'

Erros, limites e rastreamento

Toda resposta recebe X-Request-Id. Respostas autenticadas também informam RateLimit-Limit, RateLimit-Remaining e RateLimit-Reset.

{
  "error": {
    "type": "invalid_request",
    "code": "invalid_query_parameter",
    "message": "limit must be an integer from 1 to 100.",
    "request_id": "req_..."
  }
}

Fronteira de segurança

A API não retorna notas internas, memória da IA, credenciais, tokens, payloads de provedores, URLs privadas, regras de automação, billing ou recursos administrativos.

IDs de outro workspace resultam em 404. Mensagens exigem um escopo sensível separado. Criação, rotação e revogação de chave são ações exclusivas do owner e podem pedir confirmação adicional de identidade.