Overview

CalyxCRM provides a REST API and an MCP server for programmatic access to your organization's data. Use the REST API to build custom integrations, automate workflows, and sync data with external systems. Use the MCP server to connect AI assistants like Claude Desktop and Cursor directly to your CRM.

Getting Started

1. Create an API Key

First, you'll need an API key to authenticate your requests:

1. Navigate to Organization Settings in your dashboard
2. Click on the Developers tab
3. Click Create API Key
4. Copy and securely store your key (it's only shown once)

See API Keys for detailed instructions and security best practices.

2. Make Your First Request

Test your API key by listing the objects in your organization:

curl -X GET "https://your-domain.com/api/v1/objects" \
  -H "Authorization: Bearer caly_your_api_key_here"

3. Explore the API

The CalyxCRM API allows you to:

• Objects: Create and manage custom data structures
• Attributes: Define and manage fields on objects
• Records: CRUD, filtering, search, and bulk operations
• Activities: Log and manage interactions linked to records
• Members: View organization members
• Reports: Run reports and retrieve results
• Workflows: Trigger automation workflows
• Files: Upload files via signed URLs
• Webhooks: Subscribe to real-time CRM events

See the API Reference for complete endpoint documentation.

Quick Links

Support

If you encounter any issues or have questions about the API, please contact your organization administrator or reach out to support.