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.
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: CRM Resources (/crm/)
| Endpoint | Description |
|---|---|
GET /crm/{resource} | List records — supports all 10 resource types |
POST /crm/{resource} | Create a record — supports contact, lead, deal, meeting, company, note, task, activity |
GET /crm/{resource}/{id} | Get a single record — supports all 10 resource types |
PUT /crm/{resource}/{id} | Replace a record — supports contact, lead, deal, meeting, company, note, task, activity |
PATCH /crm/{resource}/{id} | Update specific fields — supports contact, lead, deal, meeting, company, note, task, activity |
DELETE /crm/{resource}/{id} | Delete a record — supports contact, lead, deal, meeting, company, note, task, activity |
| Endpoint | Description |
|---|---|
GET /field-mappings | List field mappings for a provider |
POST /connect/token | Create a connect session token |
owner and pipeline are read-only — they are managed by the provider and support list and get operations only.