Overview
Consuelo exposes a powerful GraphQL API that you can use to build internal tools, automate workflows, and extract analytics for your growth operations. This documentation covers patterns and best practices for using the API as your internal growth operating system.
Why Use the GraphQL API
While Consuelo’s UI covers standard CRM workflows, the GraphQL API enables:
- Custom analytics dashboards that go beyond built-in reporting
- Automated data operations at scale
- Integration with external tools like BI platforms, data warehouses, and notification systems
- Scripted workflows for maintenance, cleanup, and bulk operations
API Endpoints
| Environment | Endpoint |
|---|
| Cloud | https://api.consuelohq.com/graphql |
| Self-Hosted | https://{your-domain}/graphql |
Authentication
All requests require a Bearer token:
Authorization: Bearer YOUR_API_KEY
Creating an API Key
- Go to Settings → APIs & Webhooks
- Click + Create key
- Give it a descriptive name (e.g., “Growth Analytics”)
- Set an expiration date
- Copy the key immediately (shown only once)
Core API
Accessed at /graphql - work with your actual records:
- Query and mutate People, Companies, Opportunities, etc.
- Perform bulk operations
- Extract analytics data
Accessed at /metadata - manage your workspace schema:
- Create custom objects and fields
- Configure relationships
- Manage workspace settings
Rate Limits
| Limit | Value |
|---|
| Requests | 100 calls per minute |
| Batch size | 60 records per call |
Use batch operations to maximize throughput. A single batch call can process 60 records.
Next Steps
