API Reference

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

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:

X-API-Key: your_api_key_here

Or using Bearer token format:

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

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

3. Response

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

Available Endpoints

Contacts

Method	Endpoint	Description
GET	/contacts	List all contacts
GET	/contacts/:id	Retrieve a contact
POST	/contacts	Create a contact
PUT	/contacts/:id	Update a contact
DELETE	/contacts/:id	Delete a contact

Opportunities

Method	Endpoint	Description
GET	/opportunities	List all opportunities
GET	/opportunities/:id	Retrieve an opportunity
GET	/opportunities/:id/history	Retrieve stage/value history
POST	/opportunities	Create an opportunity
PUT	/opportunities/:id	Update an opportunity
PATCH	/opportunities/:id/stage	Update opportunity stage
DELETE	/opportunities/:id	Delete an opportunity

Campaigns

Method	Endpoint	Description
GET	/campaigns	List all campaigns
POST	/campaigns/:id/contacts	Add a contact to a campaign

Conversations

Method	Endpoint	Description
GET	/conversations	List conversations (incl. AI qualification)
GET	/conversations/:id	Retrieve a conversation with its messages

Reports

Method	Endpoint	Description
GET	/reports/funnel	Per-stage funnel (count + value) per pipeline
GET	/reports/sales-summary	Open / won / lost counts and values
GET	/reports/sellers	Per-seller KPIs (revenue, ticket, conversion)
GET	/reports/sla	Avg durations (response time, qualification, sales cycle)

Reference Data

Method	Endpoint	Description
GET	/pipelines	List pipelines and their stages
GET	/sectors	List sectors/teams
GET	/tags	List tags
GET	/discard-reasons	List loss/discard reasons
GET	/products	List the product/service catalog
GET	/users	List team members (sellers)

Instagram Agents

Method	Endpoint	Description
GET	/instagram-agents	List all Instagram agents
POST	/instagram-agents/:id/profiles	Add a profile to an agent

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:

Permission	Description
contacts:read	Read contact data
contacts:write	Create and update contacts
contacts:delete	Delete contacts
opportunities:read	Read opportunity data
opportunities:write	Create and update opportunities
opportunities:delete	Delete opportunities
campaigns:read	Read campaign data
campaigns:write	Add contacts to campaigns
conversations:read	Read conversations and messages (incl. AI qualification)
reports:read	Read aggregated commercial reports (funnel, sales summary, sellers)
pipelines:read	Read pipelines and stages
sectors:read	Read sectors/teams
tags:read	Read tags
discard_reasons:read	Read loss/discard reasons
products:read	Read the product/service catalog
users:read	Read team members (sellers)
instagram_agents:read	Read Instagram agent data
instagram_agents:write	Add profiles to agents

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