Skip to main content

Docs

Public API docs launch — API reference, Rate limits, and the SICAR V4 catalog.Authenticate with an API key: Authorization: Bearer sk_live_…

API changes

Success responses use a consistent envelope:
  • Single resource → { "data": { … } }
  • Lists → { "data": [ … ], "meta": { page, per_page, total_pages, total_count } }
  • Deletes → { "data": { "ok": true } } (saved SQL DELETE stays HTTP 204)
  • Errors stay { "error": { … } } — not wrapped in data
Optional list params: page, per_page (max 100). Omit both for the full set.

Rate limits

Plan-based requests/minute per account: Free 100 · Pro 500 · Platform 1000 · Enterprise 2000. Headers X-RateLimit-* and 429 + Retry-After.

Customers, licenses & devices

External ids on create + list filter: external_customer_id, external_license_id, external_device_id (max 200). Unique when set.Device lifecycle: pending → enrolled → revoked. Delete customer blocked while active licenses/devices exist; delete license/device only after revoke.Revoke license requires no linked pending/enrolled devices first (409 with details.device_id / details.device_ids). See Licenses → Revoke.

SICAR V4

Initial function catalog: products, inventory, catalog lookups, sales/quotes/purchase orders, creates, and custom SQL (select / query / validate). See the full catalog.