Unified API Format – Overview

General Access Model

This API provides a flexible format-based interface for most routes by appending format suffixes like .json, .xml, .html, .csv, or .xls to any valid endpoint.

Example endpoint: /crm/list
Available formats:

• /crm/list.json – JSON API
• /crm/list.xml – XML API
• /crm/list.html – Bare HTML version (no menu; iframe-friendly)
• /crm/list.csv – Export as CSV
• /crm/list.xls – Export as Excel

Authentication

All requests require a valid Bearer token, which can be generated through the organization portal.

Example Header

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Tokens are scoped per organization and expire according to security settings.

Response Format Examples

JSON Response

{
  "status": "ok",
  "data": [
    { "id": 1, "name": "Acme Corp", "status": "active" },
    { "id": 2, "name": "Beta LLC", "status": "lead" }
  ]
}

CSV Response

id,name,status
1,Acme Corp,active
2,Beta LLC,lead

Use Cases

• Web Embeds: Use .html for iframe-friendly views without menus.
• Automation: Fetch structured data in .json or .xml for use in scripts.
• Reporting: Export data in .csv or .xls for spreadsheet processing.

Security Notes

• Always use HTTPS to avoid leaking bearer tokens.
• Do not store long-lived tokens on frontend clients.
• Tokens can be revoked or rotated via the organization admin panel.