API Reference

CYFIA API Documentation

CYFIA provides REST, GraphQL, and gRPC APIs for programmatic access to every module. All endpoints are versioned, fully documented, and include interactive examples.

The CYFIA API is designed around REST principles with predictable resource-oriented URLs, JSON-encoded request bodies, and standard HTTP response codes. For real-time updates, we offer Server-Sent Events (SSE) and WebSocket endpoints. All API access requires authentication via JWT tokens or API keys.

Authentication Methods

JWT Tokens

Obtained via /admin_api/v1/login. Include in Authorization: Bearer <token> header. Expires in 24 hours.

API Keys

For server-to-server communication. Generated in Dashboard → Settings → API Keys. Include in X-API-Key header.

OAuth 2.1 / OIDC

Enterprise SSO integration. Supports Google, Microsoft, Okta, and custom OIDC providers.

Base URL

# Production https://api.cyfia.com/v1

# Sandbox / Testing https://sandbox.cyfia.com/v1

All API requests must be made over HTTPS. HTTP requests will receive a 301 Moved Permanently redirect.

Rate Limits

Plan	Requests / Minute	Burst Allowance	WebSocket Connections
Free	1,000	100	5
Starter	10,000	500	50
Professional	100,000	2,000	500
Enterprise	Custom	Custom	Unlimited

Rate limit headers are included in every response: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

Core API

Finance Engine

Double-entry ledger, multi-currency transactions, tax computation, and payment processing.

GET /v1/finance/ledger Retrieve ledger entries

Query Parameters

Parameter	Type	Description
account_id	UUID	Filter by account
from_date	ISO 8601	Start date for entries
to_date	ISO 8601	End date for entries
limit*	Integer	Max 100 per request

Example Response

              
{
  "entries": [
    {
      "id": "a1b2c3d4",
      "account": "cash_main",
      "debit": 1500.00,
      "credit": 0.00,
      "currency": "USD",
      "timestamp": "2026-05-11T10:30:00Z"
    }
  ],
  "total": 1,
  "has_more": false
}
            

Core API

Inventory & Supply Chain

Multi-warehouse stock management, serial/lot tracking, and automated replenishment.

POST /v1/inventory/items Create inventory item

Request Body

              
{
  "sku": "SKU-3001",
  "name": "Organic Coffee Beans",
  "warehouse_id": "wh_nyc_01",
  "quantity": 500,
  "safety_stock": 100,
  "unit_price": 24.99
}
            

Core API

CRM & Engagement

Contact graph, pipeline orchestration, omnichannel inbox, and SLA-driven support desk.

GET /v1/crm/contacts List contacts

Example Response

              
{
  "contacts": [
    {
      "id": "c9d8e7f6",
      "name": "Alice Johnson",
      "email": "alice@example.com",
      "pipeline_stage": "negotiation",
      "assigned_to": "user_42"
    }
  ]
}
            

Core API

Human Resources

Employee management, attendance tracking, leave requests, and payroll sync.

GET /v1/hr/employees List employees

              
{
  "employees": [
    {
      "id": "emp_123",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@company.com",
      "department": "Engineering",
      "role": "Senior Developer"
    }
  ]
}
            

Error Handling

CYFIA uses standard HTTP status codes. All errors return a consistent JSON body with error_code, message, and optional details array.

          
{
  "error_code": "INSUFFICIENT_PERMISSIONS",
  "message": "You do not have access to this resource",
  "details": [
    "Required role: admin or manager"
  ],
  "request_id": "req_a1b2c3d4"
}
        

Finance Core

Supply Chain

Workflow Engine

Security Layer

CYFIA API Documentation

Authentication Methods

JWT Tokens

API Keys

OAuth 2.1 / OIDC

Base URL

Rate Limits

Finance Engine

Query Parameters

Example Response

Inventory & Supply Chain

Request Body

CRM & Engagement

Example Response

Human Resources

Error Handling