# FluentCRM REST API

Welcome to the FluentCRM REST API documentation. This comprehensive guide will help you integrate with FluentCRM using RESTful HTTP requests to manage contacts, campaigns, automations, and more.

# Overview

The FluentCRM REST API provides programmatic access to your FluentCRM data through standard HTTP methods. You can use this API to:

Manage Contacts: Create, read, update, and delete subscriber information
Handle Lists & Tags: Organize contacts with lists and tags
Control Campaigns: Manage email campaigns and sequences
Access Analytics: Retrieve performance data and reports
Configure Automations: Set up and manage automation funnels
Integrate Systems: Connect FluentCRM with external applications

# Base URL

All API requests should be made to:

https://yourdomain.com/wp-json/fluent-crm/v2

# Quick Start

# Available Resources

# Core Resources

Authentication - Secure your API access
Contacts - Manage subscriber data
Lists - Organize contacts into lists
Tags - Categorize contacts with tags
Companies - Manage company information
Custom Fields - Handle custom contact data

# Email & Campaigns

Email Templates - Create and manage email templates
Email Sequences - Set up automated email sequences
Campaigns - Manage email campaigns

# Automation & Analytics

Automation Funnels - Configure marketing automations
Reports - Access analytics and performance data
Webhooks - Set up webhook integrations

# Response Format

All API responses are returned in JSON format with consistent structure:

{
  "data": {}, // Response data
  "message": "Success message",
  "total": 100, // For paginated responses
  "current_page": 1,
  "per_page": 15
}

1
2
3
4
5
6
7

# Error Handling

The API uses standard HTTP status codes and returns detailed error messages:

{
  "code": "rest_invalid_param",
  "message": "Invalid parameter: email is required",
  "data": {
    "status": 400
  }
}

1
2
3
4
5
6
7

# SDKs and Tools

While we don't provide official SDKs, the API works with any HTTP client library:

PHP: Guzzle, cURL
JavaScript: Axios, Fetch API
Python: Requests
Ruby: HTTParty
Any language that supports HTTP requests

# Support

For support and assistance:

Documentation Issues: Submit a GitHub issue (opens new window)
API Questions: Contact support (opens new window)
Feature Requests/Suggestions: Community forum (opens new window)

# What's Next?

Ready to start building? Begin with Authentication to set up your API access.

Authentication →