Start free
API reference

Platform API v2

Use the generated API contract for the full echowin platform.

The v2 API is the contract used by the portal and the platform MCP tools.

Use the generated contract

Read OpenAPI JSON for resource paths, input fields, response shapes and required permissions. The document is generated by the API Worker; the public site does not fetch a live account or database to build this page.

Use the authentication scheme declared for the operation. Keep credentials on a trusted server and grant the narrow access your integration needs. Tenant-owned records remain scoped to their team.

Writes and retries

Send an Idempotency-Key for writes as required by the operation. Reuse the same key only when retrying the same request. Check the response before deciding whether to retry. A network failure does not prove that the write failed.

Pagination and errors

Follow cursor pagination rather than constructing an offset from an item count. Treat validation, authorization and rate-limit errors separately. Use the request identifier to investigate failures while keeping credentials and customer data out of logs.

Existing clients

Keep existing v1 clients on their frozen contract while you test a deliberate move to v2. Start with the authentication guide. Do not mix response parsers or authentication assumptions between versions.