March 2026
API Documentation Launch
The RouteMCP API documentation site is now live.What’s Included
- API Reference — Auto-generated from OpenAPI spec with interactive playground
- Quickstart Guide — End-to-end walkthrough from API key to fetching contacts
- Authentication Guide — API key usage with code examples
- Connect Widget Guide — Embedding the provider authorization flow
- Field Mappings Guide — Understanding the unified schema
- Error Codes Reference — Complete error catalog with resolution steps
- Rate Limits Reference — Sliding window model and retry strategies
Unified API Endpoints
The following consumer-facing endpoints are documented:| Endpoint | Description |
|---|---|
GET /{resource} | List records — supports contact, lead, deal, meeting, owner |
POST /{resource} | Create a record — supports contact, lead, deal, meeting |
GET /{resource}/{id} | Get a single record — supports contact, lead, deal, meeting, owner |
PUT /{resource}/{id} | Replace a record — supports contact, lead, deal, meeting |
PATCH /{resource}/{id} | Update specific fields — supports contact, lead, deal, meeting |
DELETE /{resource}/{id} | Delete a record — supports contact, lead, deal, meeting |
GET /field-mappings | List field mappings for a provider |
POST /connect/token | Create a connect session token |
owner is read-only — it represents CRM users assigned to records and is managed entirely by the provider. Create, update, and delete operations are not supported for owners.