FluentCRM REST API ​
Complete REST API documentation for FluentCRM — covering 319 endpoints across 28 modules, including FluentCampaign Pro.
Base URL ​
All API requests use this base URL:
https://yourdomain.com/wp-json/fluent-crm/v2Authentication ​
FluentCRM uses WordPress Application Passwords for REST API authentication. Pass credentials via the Authorization header using Basic auth:
bash
curl -X GET "https://yourdomain.com/wp-json/fluent-crm/v2/subscribers" \
-H "Authorization: Basic $(echo -n 'username:application_password' | base64)"See Authentication for setup instructions.
Interactive Playground ​
Every endpoint page includes an interactive playground where you can:
- Enter your WordPress domain in the Server URL field
- Add your Application Password credentials
- Fill in parameters and execute live requests
- View real-time responses
WARNING
Use test/staging sites only. API requests make permanent changes to your data.
API Modules ​
Core Resources ​
| Module | Endpoints | Description |
|---|---|---|
| Contacts | 31 | Create, update, delete contacts; manage notes, emails, tracking events |
| Tags | 7 | Organize contacts with tags |
| Lists | 7 | Group contacts into mailing lists |
| Companies | 19 | Manage companies, attach contacts, notes, custom fields |
| Custom Fields | 3 | Define and manage custom contact fields |
| Labels | 4 | Global labels for campaigns, funnels, and sequences |
Email & Campaigns ​
| Module | Endpoints | Description |
|---|---|---|
| Campaigns | 32 | Create, schedule, send, and analyze email campaigns |
| Templates | 11 | Email templates, smart codes, global styles |
| Sequences | 18 | Automated email sequences (Pro) |
| Recurring Campaigns | 14 | Recurring/automated campaigns (Pro) |
Automation & Analytics ​
| Module | Endpoints | Description |
|---|---|---|
| Funnels | 31 | Marketing automation funnels with triggers, actions, benchmarks |
| Reports | 14 | Dashboard stats, email performance, contact growth |
| Webhooks | 5 | Incoming webhook endpoints for data collection |
| Dynamic Segments | 9 | Smart contact segments with dynamic conditions (Pro) |
Administration ​
| Module | Endpoints | Description |
|---|---|---|
| Settings | 38 | Global settings, double opt-in, integrations, compliance |
| Import | 6 | CSV upload, WP users import, third-party drivers |
| Users | 2 | WordPress user listing and roles |
| Forms | 5 | Fluent Forms integration |
| Migrators | 5 | Migrate from Mailchimp, ActiveCampaign, etc. |
| Abandon Carts | 3 | Abandoned cart tracking and recovery |
Pro Features ​
| Module | Endpoints | Description |
|---|---|---|
| Smart Links | 5 | Trackable action links (Pro) |
| Campaigns Pro | 7 | Resend emails, tag actions, dynamic content (Pro) |
| Pro Settings | 11 | License, managers, SMS settings (Pro) |
| Commerce Reports | 2 | WooCommerce/EDD revenue reports (Pro) |
| SMS | 24 | SMS campaigns, messages, subscriber SMS (Pro) |
Other ​
| Module | Endpoints | Description |
|---|---|---|
| Global Search | 1 | Search across contacts, campaigns, funnels |
| Docs | 3 | In-app documentation and addons |
| Bounce Handler | 2 | Public webhook for email bounce processing |
Response Format ​
FluentCRM returns JSON responses. Paginated endpoints use the Laravel pagination format:
json
{
"data": [{ "id": 1, "email": "[email protected]", ... }],
"total": 150,
"per_page": 15,
"current_page": 1,
"last_page": 10
}Error Handling ​
Standard HTTP status codes with descriptive error messages:
| Code | Meaning |
|---|---|
200 | Success |
400 | Bad request — missing or invalid parameters |
401 | Unauthorized — invalid or missing credentials |
403 | Forbidden — insufficient permissions |
404 | Not found — resource doesn't exist |
422 | Validation error — check the error message for details |
What's Next? ​
Start with Authentication to set up your API access, then explore any module above.