Developer Hub

Build Powerful Integrations
with the FLAIRE API

A unified, RESTful API platform giving developers full access to ERP, CRM, CMS, and Helpdesk capabilities.

View API Reference ↓ Get API Key

Quick Start

Up and running in 4 steps

From zero to your first API call in under 5 minutes.

Create an Account

Generate Your API Key

Navigate to Settings → API Keys. Create a key with the scopes you need. Keys are SHA-256 hashed and stored securely.

Make Your First Call

Use the code sample below to test your connection. Pass your API key in the X-Api-Key header.

            
            
            
        

            var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-Api-Key", "your-api-key-here");

var response = await client.GetAsync("https://api.flairehq.com/api/search/global?q=Acme");
var json = await response.Content.ReadAsStringAsync();
Console.WriteLine(json);
            import requests

headers = {"X-Api-Key": "your-api-key-here"}
response = requests.get(
    "https://api.flairehq.com/api/search/global?q=Acme",
    headers=headers
)
print(response.json())
            const response = await fetch("https://api.flairehq.com/api/search/global?q=Acme", {
    headers: { "X-Api-Key": "your-api-key-here" }
});
const data = await response.json();
console.log(data);
        

Step 4: Explore the full API reference below to discover all available endpoints.

API Explorer

Endpoint Reference

Every endpoint extracted from the real FLAIRE platform. Grouped by product.

Atlas

GET /api/search/global?q={term}

Search across customers, invoices, orders, quotes, items, vendors, and projects.

View Example

                            
                            
                        

                            {
  "results": [
    { "type": "Customer", "id": 42, "name": "Acme Corp", "match": "CompanyName" },
    { "type": "Invoice", "id": 1087, "name": "INV-1087", "match": "CustomerName" }
  ],
  "total": 2
}
                            var results = await client.GetFromJsonAsync<SearchResult>(
    "/api/search/global?q=Acme");
                        

GET /api/alerts/sidebar

Retrieve all sidebar alerts: pending approvals, overdue invoices, low stock items, late POs.

View Example

                            {
  "pendingApprovals": 4,
  "overdueInvoices": 7,
  "lowStockItems": 12,
  "latePurchaseOrders": 2
}
                        

POST /api/ai/assistant/message

Send a message to Aria with ERP business context injection.

View Example

                            // Request
{ "conversationId": "conv-123", "message": "Show me overdue invoices over $5,000" }

// Response
{ "response": "I found 3 overdue invoices over $5,000...", "tokensUsed": 847 }
                        

GET /api/ai/insights/dashboard?limit=5

Retrieve AI-generated business insights prioritized by module and severity.

POST /api/ai/insights/generate

Trigger AI insights generation — detects overdue invoices, low stock, cash flow risks, and sales trends.

GET /api/notifications/recent?count=10

Fetch recent notifications with SignalR real-time push support.

GET /api/bankaccounts/{id}/balance

Get bank account balance and recent transaction data.

POST /api/notifications/{id}/read

Mark a specific notification as read.

Nova

POST /api/AICommandApi/parse

Parse a natural language command into a structured CRM action with confidence scoring.

View Example

                            // Request
{ "command": "Create a follow-up task for Acme Corp next Tuesday" }

// Response
{
  "action": "CreateActivity",
  "entity": "Task",
  "params": { "customer": "Acme Corp", "dueDate": "2026-03-24" },
  "confidence": 0.94
}
                        

POST /api/AICommandApi/execute

Parse and execute a natural language CRM command directly.

GET /api/DashboardApi

Dashboard metrics with business unit and date range filters.

View Example

                            {
  "newLeads": 47,
  "openPipeline": 284500.00,
  "wonDeals": 12,
  "conversionRate": 0.32,
  "upcomingTasks": 8
}
                        

GET /api/NotificationsApi/recent

Real-time notification feed via SignalR — lead assignments, opportunity wins, team activities.

POST /api/TrackingController

Email open/click tracking and form submission event tracking.

POST /api/FormWebhookController

Inbound webhook receiver for external form submissions — auto-creates CRM leads.

GET /api/TagsController

Tag CRUD operations and entity filtering by tag with OR/AND toggle.

GET /api/DuplicateCheckApi

Detect duplicate records across leads, contacts, and accounts with configurable matching rules.

Vega

GET /api/v1/content/pages

List all published pages with pagination for headless frontend consumption.

View Example

                            {
  "data": [
    { "id": 1, "title": "About Us", "slug": "about-us", "status": "Published" },
    { "id": 2, "title": "Features", "slug": "features", "status": "Published" }
  ],
  "page": 1, "totalPages": 3
}
                        

GET /api/v1/content/pages/{slug}

Get a single page with full content blocks by slug — for React, Next.js, or mobile apps.

GET /api/v1/content/posts

List blog posts with filtering by category, tag, and status with pagination.

GET /api/v1/content/posts/{slug}

Get a single blog post with full content, author info, and SEO metadata.

GET /api/v1/content/categories

List blog categories with post counts for navigation and filtering.

GET /api/v1/content/menus/{location}

Get navigation menu by location (header, footer, sidebar) with hierarchy support.

GET /api/v1/content/settings

Get public site settings: name, logo URL, colors, theme, and analytics IDs.

GET /api/crm-bridge/stats

Unified CMS + CRM dashboard: form submissions, page views, lead conversion stats.

Echo

GET /api/v1/helpdesk/tickets

List support tickets with filtering by status, priority, assignee, and customer.

POST /api/v1/helpdesk/tickets

Create a new support ticket with subject, description, priority, and customer association.

GET /api/v1/helpdesk/tickets/{id}

Get full ticket details including conversation thread, attachments, and SLA status.

POST /api/v1/helpdesk/tickets/{id}/replies

Add a reply to an existing ticket — supports internal notes and customer-facing responses.

GET /api/v1/helpdesk/agents

List support agents with availability status, ticket count, and assignment queues.

GET /api/v1/helpdesk/knowledge-base

List knowledge base articles with categories for self-service portal integration.

Authentication

Secure API Access

Two authentication methods — choose what fits your integration pattern.

API Key

X-Api-Key Header

Generate keys in your dashboard. Pass via the X-Api-Key header. Keys are SHA-256 hashed at rest with usage tracking and expiry dates. Ideal for server-to-server integrations.

OAuth 2.0

Authorization Code Flow

Standard OAuth 2.0 with PKCE. Redirect to /oauth/authorize, exchange code at /oauth/token. Scoped tokens per product (crm.*, erp.*, cms.*).

Security

Best Practices

All traffic over HTTPS. Rotate keys regularly. Use minimum-scope tokens. Monitor usage via the API dashboard. Rate limits enforced per-tenant with burst protection.

Rate Limits

Rate Limits & Quotas

Limits scale with your plan. Burst protection and concurrent request limits included.

Limit	Trial	Starter	Pro	Enterprise
Daily API Calls	1,000	5,000	100,000	500,000
Burst Requests	10	30	100	190
Concurrent Limit	2	5	10	25
Cap Type	Hard cap	Hard cap	Soft (5% grace)	Soft (5% grace)
Records / Entity	500	5,000	50,000	Unlimited
File Storage	500 MB	2 GB	10 GB	100 GB
Webhook Events	Rate-limited	✗	✗	Unlimited

SDKs & Libraries

Official SDKs

Type-safe clients for your language of choice. All SDKs wrap the REST API with models and error handling.

C# / .NET SDK

Full .NET client with strongly-typed models, async methods, and retry policies.

                    // Install
dotnet add package Flaire.SDK

// Usage
var client = new FlaireClient("your-api-key");
var leads = await client.Crm.Leads.ListAsync();
var invoices = await client.Erp.Invoices.ListAsync();
var pages = await client.Cms.Pages.ListAsync();
                

Python SDK

Pythonic client with type hints, pagination helpers, and streaming support.

                    # Install
pip install flaire

# Usage
from flaire import FlaireClient

client = FlaireClient(api_key="your-api-key")
leads = client.crm.leads.list()
insights = client.erp.ai.insights(limit=5)
posts = client.cms.posts.list(category="updates")
                

JavaScript / TypeScript SDK

ESM + CJS compatible with full TypeScript definitions and tree-shaking.

                    // Install
npm install @flaire/sdk

// Usage
import { FlaireClient } from "@flaire/sdk";

const client = new FlaireClient({ apiKey: "your-api-key" });
const pages = await client.cms.pages.list();
const dashboard = await client.crm.dashboard.get();
                

Start building today

Get your API key and make your first call in under 5 minutes.

Get API Key → View Rate Limits

Free 15-day trial · 1,000 API calls/day · All endpoints available

Build Powerful Integrationswith the FLAIRE API

Up and running in 4 steps

Endpoint Reference

Atlas

Nova

Vega

Echo

Secure API Access

Rate Limits & Quotas

Official SDKs

Start building today

Build Powerful Integrations
with the FLAIRE API