API Documentation - Unified Access Format

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.

OpenAPI and SDK coverage

Use /portal/docs as the canonical OpenAPI viewer and artifact access point. Placeholder or partial specs should be treated as non-canonical until promoted there.

Stability guidance: production endpoints surfaced in SDK quickstarts are stable; additional endpoint surfaces can be beta and may be SDK-wrapped first.

Backlog task: generate/update OpenAPI from SDK-supported routes first, then expand coverage incrementally.

Unified API Format – Overview

Canonical API docs index