Skip to content
14-day free trial, no card9 languages176 business types · 50 apps
EN· USD
Try a live demoStart free trial

The reference page and the OpenAPI document

Use /api/v1/docs to browse and /api/v1/openapi.json to generate a typed client, and read the API request log when something fails.

  • about 5 min

Every server serves an HTML reference at /api/v1/docs (the hosted platform also at /api/docs) and an OpenAPI 3.1 document at /api/v1/openapi.json. Both are built from the same operation table, filtered to what that server really offers (hosted-only routes are hidden on a single-company install).

The reference shows authentication, every scope with its description, the conventions, each endpoint grouped by tag (Customers, Leads, Invoices, Catalog, Stock, Webhooks …) and the webhook signature rule.

Generate TypeScript types from the spec
curl -s https://your-workspace.zmle.com/api/v1/openapi.json -o zmle-openapi.json
npx openapi-typescript zmle-openapi.json -o src/zmle-api.d.ts
openapi-typescript is a third-party tool, not part of zmle; any OpenAPI 3.1 generator works on the document.

The API request log

Every write and every refused call (and a sample of reads, once per key, path and minute) is stored in the audit log for 90 days, with the key or app sign-in, the person, the address and the request id. Admins open it at Admin → Integrations & API → API request log (/admin/integrations/requests). Quote the X-Request-Id of a failing call to find it.

Written from: src/lib/api-v1/docs.ts, src/lib/integrations/openapi.ts, src/lib/api-v1/pipeline.ts, docs/API.md