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/v1Autenticacao
Todas as requisicoes a API exigem autenticacao usando uma chave de API. Inclua sua chave no header da requisicao:
X-API-Key: sua_chave_api_aquiOu usando o formato Bearer token:
Authorization: Bearer sua_chave_api_aquiInicio 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
curl --request GET \
--url "https://app.getraze.com/external/v1/contacts" \
--header "X-API-Key: YOUR_API_KEY"3. Resposta
{
"success": true,
"data": [...],
"pagination": {
"page": 1,
"per_page": 50,
"total": 150,
"total_pages": 3,
"has_next": true,
"has_prev": false
}
}Endpoints Disponiveis
Contatos
| Metodo | Endpoint | Descricao |
|---|---|---|
| GET | /contacts | Listar todos os contatos |
| GET | /contacts/:id | Buscar um contato |
| POST | /contacts | Criar um contato |
| PUT | /contacts/:id | Atualizar um contato |
| DELETE | /contacts/:id | Excluir um contato |
Oportunidades
| Metodo | Endpoint | Descricao |
|---|---|---|
| GET | /opportunities | Listar todas as oportunidades |
| GET | /opportunities/:id | Buscar uma oportunidade |
| GET | /opportunities/:id/history | Buscar historico de etapa/valor |
| POST | /opportunities | Criar uma oportunidade |
| PUT | /opportunities/:id | Atualizar uma oportunidade |
| PATCH | /opportunities/:id/stage | Atualizar estagio da oportunidade |
| DELETE | /opportunities/:id | Excluir uma oportunidade |
Pipelines
Os pipeline_id e stage_id usados pelos endpoints de oportunidades vêm daqui.
| Metodo | Endpoint | Descricao |
|---|---|---|
| GET | /pipelines | Listar pipelines e suas etapas |
| GET | /pipelines/:id | Buscar um pipeline com suas etapas |
| GET | /pipelines/:id/stages | Etapas de um pipeline com quantidade e valor dos cards |
| GET | /pipelines/:id/stages/:stageId | Buscar uma etapa |
Tarefas
| Método | Endpoint | Descrição |
|---|---|---|
| GET | /tasks | Listar tarefas |
| GET | /tasks/:id | Buscar uma tarefa com as subtarefas |
| POST | /tasks | Criar uma tarefa |
| PUT | /tasks/:id | Atualizar uma tarefa |
| PATCH | /tasks/:id/status | Mover para pendente / em andamento / concluída |
| PATCH | /tasks/:id/complete | Concluir uma tarefa |
| DELETE | /tasks/:id | Excluir uma tarefa |
| GET | /tasks/:id/comments | Listar os comentários de uma tarefa |
| POST | /tasks/:id/comments | Comentar em uma tarefa |
| GET | /task-pipelines | Listar pipelines de tarefas |
| GET | /task-labels | Listar etiquetas de tarefa |
Playbooks
| Método | Endpoint | Descrição |
|---|---|---|
| GET | /playbooks | Listar playbooks |
| GET | /playbooks/:id | Buscar um playbook com as etapas |
| POST | /playbooks/:id/runs | Iniciar uma execução de playbook |
| GET | /playbook-runs | Listar execuções de playbook |
| GET | /playbook-runs/:id | Buscar uma execução com as etapas |
| POST | /playbook-runs/:id/cancel | Cancelar uma execução |
| POST | /playbook-runs/:id/reschedule | Reagendar uma execução atrasada a partir de agora |
Campanhas
| Metodo | Endpoint | Descricao |
|---|---|---|
| GET | /campaigns | Listar todas as campanhas |
| POST | /campaigns/:id/contacts | Adicionar um contato a uma campanha |
Conversas
| Metodo | Endpoint | Descricao |
|---|---|---|
| GET | /conversations | Listar conversas (incl. qualificacao por IA) |
| GET | /conversations/:id | Buscar uma conversa com suas mensagens |
Relatorios
| Metodo | Endpoint | Descricao |
|---|---|---|
| GET | /reports/funnel | Funil por etapa (contagem + valor) por pipeline |
| GET | /reports/sales-summary | Contagens e valores de abertas / ganhas / perdidas |
| GET | /reports/sellers | KPIs por vendedor (receita, ticket, conversao) |
| GET | /reports/sla | Duracoes medias (tempo de resposta, qualificacao, ciclo) |
Dados de Referencia
| Metodo | Endpoint | Descricao |
|---|---|---|
| GET | /sectors | Listar setores/times |
| GET | /tags | Listar tags |
| GET | /discard-reasons | Listar motivos de perda/descarte |
| GET | /products | Listar o catalogo de produtos/servicos |
| GET | /users | Listar membros do time (vendedores) |
| GET | /custom-fields | Listar definicoes de campos personalizados (chaves, tipos, opcoes) |
| GET | /projects | Listar projetos do CRM (os grupos dos pipelines) |
Agentes de Instagram
| Metodo | Endpoint | Descricao |
|---|---|---|
| GET | /instagram-agents | Listar todos os agentes de Instagram |
| POST | /instagram-agents/:id/profiles | Adicionar um perfil a um agente |
Entrada da Agencia
Apenas para agencias whitelabel. Usa URL base e autenticacao diferentes — veja API de Entrada da Agencia.
| Metodo | Endpoint | Descricao |
|---|---|---|
| POST | /sub-accounts | Criar uma sub-conta |
| PUT | /sub-accounts/:ref/channels | Alterar cotas de canais |
| DELETE | /sub-accounts/:ref | Excluir uma sub-conta |
| GET | /events/:event_id | Consultar 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 horaX-RateLimit-Remaining: Requisicoes restantesX-RateLimit-Reset: Timestamp Unix de quando o limite reinicia
Permissoes
As chaves de API utilizam permissoes granulares:
| Permissao | Descricao |
|---|---|
contacts:read | Ler dados de contatos |
contacts:write | Criar e atualizar contatos |
contacts:delete | Excluir contatos |
opportunities:read | Ler dados de oportunidades |
opportunities:write | Criar e atualizar oportunidades |
opportunities:delete | Excluir oportunidades |
campaigns:read | Ler dados de campanhas |
campaigns:write | Adicionar contatos a campanhas |
conversations:read | Ler conversas e mensagens (incl. qualificacao por IA) |
reports:read | Ler relatorios comerciais agregados (funil, resumo de vendas, vendedores) |
pipelines:read | Ler pipelines e etapas |
sectors:read | Ler setores/times |
tags:read | Ler tags |
discard_reasons:read | Ler motivos de perda/descarte |
products:read | Ler o catalogo de produtos/servicos |
users:read | Ler membros do time (vendedores) |
custom_fields:read | Ler definicoes de campos personalizados |
projects:read | Ler projetos do CRM |
instagram_agents:read | Ler dados de agentes de Instagram |
instagram_agents:write | Adicionar perfis a agentes |
tasks:read | Ler tarefas, comentários, pipelines e etiquetas de tarefa |
tasks:write | Criar, atualizar, concluir e comentar tarefas |
tasks:delete | Excluir tarefas |
playbooks:read | Ler playbooks, suas etapas e execuções |
playbooks:run | Iniciar, cancelar e reagendar execuções de playbook |
Permissoes com wildcard sao suportadas (ex.: contacts:* concede todas as permissoes de contatos).