API Documentation
Build powerful integrations with RedFox CRM's REST API. Access your customer data, emails, invoices, estimates, and proposals programmatically.
API keys are managed securely in your account settings. Only authenticated users can create and manage keys.
Get StartedBase URL
Universal API endpoint for all requests:
https://redfoxcrm.com/api/v1
All endpoints use this base URL. Your API key determines which organization's data you can access.
Authentication
Getting Started
You need an API key to use this API. Log in to your account and go to Settings > API Keys to create one.
API Key Format
API keys start with the prefix rfx_live_ and are sent in the Authorization header:
Authorization: Bearer rfx_live_YOUR_API_KEY_HERE
cURL Example
curl -H "Authorization: Bearer rfx_live_YOUR_API_KEY" \ https://redfoxcrm.com/api/v1/customers
JavaScript Example
const response = await fetch('https://redfoxcrm.com/api/v1/customers', {
headers: {
'Authorization': 'Bearer rfx_live_YOUR_API_KEY'
}
});
const data = await response.json();Python Example
import requests
headers = {
'Authorization': 'Bearer rfx_live_YOUR_API_KEY'
}
response = requests.get(
'https://redfoxcrm.com/api/v1/customers',
headers=headers
)
data = response.json()API Endpoints
/customers
Retrieve all customers for your organization.
Query Parameters
page - Page number (default: 1)limit - Results per page (default: 20, max: 100)search - Search by name or emailExample Request
curl -H "Authorization: Bearer rfx_live_YOUR_API_KEY" \ 'https://redfoxcrm.com/api/v1/customers?page=1&limit=20'
Response
{
"data": [
{
"id": "uuid",
"name": "Customer Name",
"email": "customer@example.com",
"phone": "+1234567890",
"created_at": "2024-01-01T00:00:00Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 150
}
}/emails
Retrieve emails (incoming and outgoing) for your organization.
Query Parameters
page - Page number (default: 1)limit - Results per page (default: 20, max: 100)type - Filter by type: all, incoming, outgoing/invoices
Retrieve invoices for your organization.
Query Parameters
page - Page number (default: 1)limit - Results per page (default: 20, max: 100)status - Filter by status: all, draft, sent, paid/estimates
Retrieve estimates for your organization.
Query Parameters
page - Page number (default: 1)limit - Results per page (default: 20, max: 100)status - Filter by status: all, draft, sent, accepted, declined/proposals
Retrieve proposals for your organization.
Query Parameters
page - Page number (default: 1)limit - Results per page (default: 20, max: 100)status - Filter by status: all, draft, sent, accepted, declinedError Handling
Bad Request
Invalid query parameters or request format.
Unauthorized
Missing or invalid API key. Verify your Authorization header.
Forbidden
Your API key doesn't have the required scope for this endpoint.
Too Many Requests
Rate limit exceeded. Wait before making additional requests.
Server Error
An internal server error occurred. Please try again later.
Manage Your API Keys
Create, view, and revoke API keys from your account settings. Keys are sensitive—never share them or commit them to version control.
Go to Account Settings