Skip to content

API Reference ​

Welcome to the GetRaze API. Use our REST API to integrate GetRaze functionality into your applications.

Using an AI agent?

Claude Code, Cursor, the OpenAI Agents SDK and n8n can drive GetRaze through the MCP server with the same API keys.

Base URL ​

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

Authentication ​

All API requests require authentication using an API key. Include your API key in the request header:

bash
X-API-Key: your_api_key_here

Or using Bearer token format:

bash
Authorization: Bearer your_api_key_here

Quick Start ​

1. Get your API Key ​

Navigate to Config > API Keys in your GetRaze dashboard to create a new API key.

2. Make your first request ​

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

3. Response ​

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

Available Endpoints ​

Contacts ​

MethodEndpointDescription
GET/contactsList all contacts
GET/contacts/:idRetrieve a contact
POST/contactsCreate a contact
PUT/contacts/:idUpdate a contact
DELETE/contacts/:idDelete a contact

Opportunities ​

MethodEndpointDescription
GET/opportunitiesList all opportunities
GET/opportunities/:idRetrieve an opportunity
GET/opportunities/:id/historyRetrieve stage/value history
POST/opportunitiesCreate an opportunity
PUT/opportunities/:idUpdate an opportunity
PATCH/opportunities/:id/stageUpdate opportunity stage
DELETE/opportunities/:idDelete an opportunity

Pipelines ​

pipeline_id and stage_id used by the opportunities endpoints come from here.

MethodEndpointDescription
GET/pipelinesList pipelines and their stages
GET/pipelines/:idRetrieve a pipeline with its stages
GET/pipelines/:id/stagesStages of a pipeline with card count and value
GET/pipelines/:id/stages/:stageIdRetrieve one stage

Tasks ​

MethodEndpointDescription
GET/tasksList tasks
GET/tasks/:idRetrieve a task with its subtasks
POST/tasksCreate a task
PUT/tasks/:idUpdate a task
PATCH/tasks/:id/statusMove to pending / in progress / completed
PATCH/tasks/:id/completeComplete a task
DELETE/tasks/:idDelete a task
GET/tasks/:id/commentsList the comments of a task
POST/tasks/:id/commentsComment on a task
GET/task-pipelinesList task pipelines (boards)
GET/task-labelsList task labels

Playbooks ​

MethodEndpointDescription
GET/playbooksList playbooks
GET/playbooks/:idRetrieve a playbook with its steps
POST/playbooks/:id/runsStart a playbook run
GET/playbook-runsList playbook runs
GET/playbook-runs/:idRetrieve a run with its steps
POST/playbook-runs/:id/cancelCancel a run
POST/playbook-runs/:id/rescheduleReschedule a late run from now

Campaigns ​

MethodEndpointDescription
GET/campaignsList all campaigns
POST/campaigns/:id/contactsAdd a contact to a campaign

Conversations ​

MethodEndpointDescription
GET/conversationsList conversations (incl. AI qualification)
GET/conversations/:idRetrieve a conversation with its messages

Reports ​

MethodEndpointDescription
GET/reports/funnelPer-stage funnel (count + value) per pipeline
GET/reports/sales-summaryOpen / won / lost counts and values
GET/reports/sellersPer-seller KPIs (revenue, ticket, conversion)
GET/reports/slaAvg durations (response time, qualification, sales cycle)

Reference Data ​

MethodEndpointDescription
GET/sectorsList sectors/teams
GET/tagsList tags
GET/discard-reasonsList loss/discard reasons
GET/productsList the product/service catalog
GET/usersList team members (sellers)
GET/custom-fieldsList custom field definitions (keys, types, options)
GET/projectsList CRM projects (the groups pipelines belong to)

Instagram Agents ​

MethodEndpointDescription
GET/instagram-agentsList all Instagram agents
POST/instagram-agents/:id/profilesAdd a profile to an agent

Agency Inbound ​

For whitelabel agencies only. Uses a different base URL and authentication — see Agency Inbound API.

MethodEndpointDescription
POST/sub-accountsCreate a sub-account
PUT/sub-accounts/:ref/channelsUpdate channel quotas
DELETE/sub-accounts/:refDelete a sub-account
GET/events/:event_idRetrieve the outcome of a call

Rate Limits ​

Each API key has configurable rate limits. Default is 1000 requests per hour.

Rate limit information is included in response headers:

  • X-RateLimit-Limit: Maximum requests per hour
  • X-RateLimit-Remaining: Remaining requests
  • X-RateLimit-Reset: Unix timestamp when limit resets

Permissions ​

API keys use granular permissions:

PermissionDescription
contacts:readRead contact data
contacts:writeCreate and update contacts
contacts:deleteDelete contacts
opportunities:readRead opportunity data
opportunities:writeCreate and update opportunities
opportunities:deleteDelete opportunities
campaigns:readRead campaign data
campaigns:writeAdd contacts to campaigns
conversations:readRead conversations and messages (incl. AI qualification)
reports:readRead aggregated commercial reports (funnel, sales summary, sellers)
pipelines:readRead pipelines and stages
sectors:readRead sectors/teams
tags:readRead tags
discard_reasons:readRead loss/discard reasons
products:readRead the product/service catalog
users:readRead team members (sellers)
custom_fields:readRead custom field definitions
projects:readRead CRM projects
instagram_agents:readRead Instagram agent data
instagram_agents:writeAdd profiles to agents
tasks:readRead tasks, task comments, task pipelines and labels
tasks:writeCreate, update, complete and comment on tasks
tasks:deleteDelete tasks
playbooks:readRead playbooks, their steps and runs
playbooks:runStart, cancel and reschedule playbook runs

Wildcard permissions are supported (e.g., contacts:* grants all contact permissions).

GetRaze - AI-Powered Lead Generation