Skip to content

Referencia da API ​

Bem-vindo a API do GetRaze. Use nossa API REST para integrar as funcionalidades do GetRaze nas suas aplicacoes.

Usando um agente de IA?

Claude Code, Cursor, OpenAI Agents SDK e n8n operam o GetRaze pelo servidor MCP com as mesmas chaves de API.

URL Base ​

https://app.getraze.com/external/v1

Autenticacao ​

Todas as requisicoes a API exigem autenticacao usando uma chave de API. Inclua sua chave no header da requisicao:

bash
X-API-Key: sua_chave_api_aqui

Ou usando o formato Bearer token:

bash
Authorization: Bearer sua_chave_api_aqui

Inicio Rapido ​

1. Obtenha sua Chave de API ​

Navegue ate Configuracoes > Chaves de API no painel do GetRaze para criar uma nova chave de API.

2. Faca sua primeira requisicao ​

bash
curl --request GET \
  --url "https://app.getraze.com/external/v1/contacts" \
  --header "X-API-Key: YOUR_API_KEY"

3. Resposta ​

json
{
  "success": true,
  "data": [...],
  "pagination": {
    "page": 1,
    "per_page": 50,
    "total": 150,
    "total_pages": 3,
    "has_next": true,
    "has_prev": false
  }
}

Endpoints Disponiveis ​

Contatos ​

MetodoEndpointDescricao
GET/contactsListar todos os contatos
GET/contacts/:idBuscar um contato
POST/contactsCriar um contato
PUT/contacts/:idAtualizar um contato
DELETE/contacts/:idExcluir um contato

Oportunidades ​

MetodoEndpointDescricao
GET/opportunitiesListar todas as oportunidades
GET/opportunities/:idBuscar uma oportunidade
GET/opportunities/:id/historyBuscar historico de etapa/valor
POST/opportunitiesCriar uma oportunidade
PUT/opportunities/:idAtualizar uma oportunidade
PATCH/opportunities/:id/stageAtualizar estagio da oportunidade
DELETE/opportunities/:idExcluir uma oportunidade

Pipelines ​

Os pipeline_id e stage_id usados pelos endpoints de oportunidades vêm daqui.

MetodoEndpointDescricao
GET/pipelinesListar pipelines e suas etapas
GET/pipelines/:idBuscar um pipeline com suas etapas
GET/pipelines/:id/stagesEtapas de um pipeline com quantidade e valor dos cards
GET/pipelines/:id/stages/:stageIdBuscar uma etapa

Tarefas ​

MétodoEndpointDescrição
GET/tasksListar tarefas
GET/tasks/:idBuscar uma tarefa com as subtarefas
POST/tasksCriar uma tarefa
PUT/tasks/:idAtualizar uma tarefa
PATCH/tasks/:id/statusMover para pendente / em andamento / concluída
PATCH/tasks/:id/completeConcluir uma tarefa
DELETE/tasks/:idExcluir uma tarefa
GET/tasks/:id/commentsListar os comentários de uma tarefa
POST/tasks/:id/commentsComentar em uma tarefa
GET/task-pipelinesListar pipelines de tarefas
GET/task-labelsListar etiquetas de tarefa

Playbooks ​

MétodoEndpointDescrição
GET/playbooksListar playbooks
GET/playbooks/:idBuscar um playbook com as etapas
POST/playbooks/:id/runsIniciar uma execução de playbook
GET/playbook-runsListar execuções de playbook
GET/playbook-runs/:idBuscar uma execução com as etapas
POST/playbook-runs/:id/cancelCancelar uma execução
POST/playbook-runs/:id/rescheduleReagendar uma execução atrasada a partir de agora

Campanhas ​

MetodoEndpointDescricao
GET/campaignsListar todas as campanhas
POST/campaigns/:id/contactsAdicionar um contato a uma campanha

Conversas ​

MetodoEndpointDescricao
GET/conversationsListar conversas (incl. qualificacao por IA)
GET/conversations/:idBuscar uma conversa com suas mensagens

Relatorios ​

MetodoEndpointDescricao
GET/reports/funnelFunil por etapa (contagem + valor) por pipeline
GET/reports/sales-summaryContagens e valores de abertas / ganhas / perdidas
GET/reports/sellersKPIs por vendedor (receita, ticket, conversao)
GET/reports/slaDuracoes medias (tempo de resposta, qualificacao, ciclo)

Dados de Referencia ​

MetodoEndpointDescricao
GET/sectorsListar setores/times
GET/tagsListar tags
GET/discard-reasonsListar motivos de perda/descarte
GET/productsListar o catalogo de produtos/servicos
GET/usersListar membros do time (vendedores)
GET/custom-fieldsListar definicoes de campos personalizados (chaves, tipos, opcoes)
GET/projectsListar projetos do CRM (os grupos dos pipelines)

Agentes de Instagram ​

MetodoEndpointDescricao
GET/instagram-agentsListar todos os agentes de Instagram
POST/instagram-agents/:id/profilesAdicionar um perfil a um agente

Entrada da Agencia ​

Apenas para agencias whitelabel. Usa URL base e autenticacao diferentes — veja API de Entrada da Agencia.

MetodoEndpointDescricao
POST/sub-accountsCriar uma sub-conta
PUT/sub-accounts/:ref/channelsAlterar cotas de canais
DELETE/sub-accounts/:refExcluir uma sub-conta
GET/events/:event_idConsultar o desfecho de uma chamada

Limites de Requisicao ​

Cada chave de API possui limites de requisicao configuraveis. O padrao e 1000 requisicoes por hora.

As informacoes de limite sao incluidas nos headers da resposta:

  • X-RateLimit-Limit: Maximo de requisicoes por hora
  • X-RateLimit-Remaining: Requisicoes restantes
  • X-RateLimit-Reset: Timestamp Unix de quando o limite reinicia

Permissoes ​

As chaves de API utilizam permissoes granulares:

PermissaoDescricao
contacts:readLer dados de contatos
contacts:writeCriar e atualizar contatos
contacts:deleteExcluir contatos
opportunities:readLer dados de oportunidades
opportunities:writeCriar e atualizar oportunidades
opportunities:deleteExcluir oportunidades
campaigns:readLer dados de campanhas
campaigns:writeAdicionar contatos a campanhas
conversations:readLer conversas e mensagens (incl. qualificacao por IA)
reports:readLer relatorios comerciais agregados (funil, resumo de vendas, vendedores)
pipelines:readLer pipelines e etapas
sectors:readLer setores/times
tags:readLer tags
discard_reasons:readLer motivos de perda/descarte
products:readLer o catalogo de produtos/servicos
users:readLer membros do time (vendedores)
custom_fields:readLer definicoes de campos personalizados
projects:readLer projetos do CRM
instagram_agents:readLer dados de agentes de Instagram
instagram_agents:writeAdicionar perfis a agentes
tasks:readLer tarefas, comentários, pipelines e etiquetas de tarefa
tasks:writeCriar, atualizar, concluir e comentar tarefas
tasks:deleteExcluir tarefas
playbooks:readLer playbooks, suas etapas e execuções
playbooks:runIniciar, cancelar e reagendar execuções de playbook

Permissoes com wildcard sao suportadas (ex.: contacts:* concede todas as permissoes de contatos).

GetRaze - AI-Powered Lead Generation