Documentation
Developer documentation for the CRM Factory API, MCP server, and admin configuration.
Build integrations, connect AI agents, and configure your workspace.
Get Started
| Guide | For | Time |
|---|---|---|
| API Sandbox | Developers exploring the REST API | 2 min |
| MCP Overview | Teams connecting AI agents | 5 min |
| Initial Setup | Admins setting up a new workspace | 10 min |
API Reference
Interactive documentation with a try-it-out sandbox powered by Scalar. Browse every endpoint, see request/response schemas, and test calls directly from the browser.
- Open API Sandbox — Interactive explorer for all 85+ endpoints
- Authentication — OAuth 2.0 and session auth
- Pagination — Cursor-based pagination conventions
- Errors — Error format and HTTP status codes
- Webhooks — Real-time event subscriptions
- OpenAPI Spec (JSON) — Machine-readable specification
Core Entities
| Entity | Endpoints | Description |
|---|---|---|
| Accounts | /api/v1/accounts | Companies and organizations |
| Contacts | /api/v1/contacts | Individual people |
| Leads | /api/v1/leads | Potential customers before qualification |
| Opportunities | /api/v1/opportunities | Sales opportunities in a pipeline |
| Cases | /api/v1/cases | Support tickets and service requests |
| Activities | /api/v1/activities | Emails, calls, meetings, tasks, notes |
| Products | /api/v1/products | Product catalog |
| Pipelines | /api/v1/pipelines | Opportunity pipeline configuration |
| Automations | /api/v1/automations | Workflow automations |
MCP Server
Connect AI assistants — Claude, ChatGPT, Cursor, and any MCP-compatible client — to your CRM data via the Model Context Protocol.
- Overview — Architecture, scopes, and capabilities
- Authentication — OAuth 2.0 authorization_code + PKCE flow
- Tools Reference — All 14 MCP tools with parameters and return types
Quick Setup Guides
Feature Guides
Deep dives on CRM Factory's core capabilities.
- Omni-Channel Messaging — WhatsApp and SMS conversations with AI-assisted replies
- Telephony & Voice — Browser softphone, click-to-dial, voicemail, and AI voice agents
- Cases & Helpdesk — Queue routing, SLA tracking, and AI-powered support
- Salesforce Migration — Analyze, map, and import your Salesforce data
- ERP Integrations — Real-time orders, pricing, and inventory from SAP, NetSuite, Dynamics, and Infor
Admin Guide
Configure your CRM Factory workspace for your organization.
- Initial Setup — Onboarding checklist and first-time configuration
- Team Management — Invite users and assign roles
- Custom Fields — Extend the data model with custom fields and layouts
- Integrations — Email, telephony, ERP, and data warehouse connections
- Automations — Event-driven workflow builder
- Billing — Plans, usage, and payment management
- Security — SSO, MFA, sessions, and audit logging