Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.routemcp.io/llms.txt

Use this file to discover all available pages before exploring further.

The RouteMCP API provides a unified interface to read and write data across multiple CRM and PMS providers. Authenticate with your API key and interact with contacts, leads, deals, meetings, companies, notes, tasks, activities, pipelines, and owners through a single, consistent API — regardless of which provider your users have connected.

​
Base URL

https://api.routemcp.io/api/v1

​
Authentication

All API requests require an API key passed in the Authorization header as a Bearer token: 
curl https://api.routemcp.io/api/v1/crm/contact?provider=hubspot \
  -H "Authorization: Bearer sk_live_your_api_key"
See the Authentication Guide for details on obtaining and managing API keys.

​
Endpoints

The API exposes three groups of endpoints:

​
CRM Resources

CRUD operations on CRM resources. The same endpoints work across all connected providers — Salesforce, HubSpot, Zoho CRM, Pipedrive, GoHighLevel, Monday CRM, and more.
MethodEndpointDescription
GET/crm/{resource}List records (with cursor pagination)
POST/crm/{resource}Create a record
GET/crm/{resource}/{id}Get a single record
PUT/crm/{resource}/{id}Replace a record
PATCH/crm/{resource}/{id}Update specific fields
DELETE/crm/{resource}/{id}Delete a record
Writable resources: contact, lead, deal, meeting, company, note, task, activity, appointment Read-only resources: owner, pipeline — support GET /{resource} (list) and GET /{resource}/{id} (get) only. These are managed by the provider and cannot be created, updated, or deleted through this API.

​
Field Mappings

MethodEndpointDescription
GET/field-mappingsList field mappings for a provider (with org overrides applied)

​
Connect

MethodEndpointDescription
POST/connect/tokenCreate a connect session token for the embedded widget

​
Response Format

All responses follow a consistent envelope: 
{
  "success": true,
  "statusCode": 200,
  "message": "Contacts retrieved",
  "data": { ... }
}
Error responses: 
{
  "success": false,
  "statusCode": 404,
  "message": "Contact does not exist",
  "code": "CONTACT_NOT_FOUND"
}

​
Pagination

List endpoints use cursor-based pagination: 
GET /api/v1/crm/contact?provider=hubspot&limit=50
ParameterTypeDefaultDescription
providerstring-Provider slug (e.g. hubspot, zoho-crm). Omit to fan out across all connected providers
cursorstring-Cursor from previous response’s pagination.cursor
limitinteger25Items per page (max 100)
Response pagination metadata: 
{
  "success": true,
  "statusCode": 200,
  "message": "OK",
  "data": {
    "data": [...],
    "pagination": {
      "cursor": "eyJpZCI6...",
      "hasMore": true,
      "limit": 25
    }
  }
}

​
API Key Types

PrefixEnvironmentDescription
sk_live_ProductionReal data from connected providers
sk_test_SandboxTest data, safe for development