Integrated API
Use this page to access the full reference and interactive playground for each version of the Integrated API.
Pre‑Requisites
  1. Onboarding complete: Access to the Integrated API documentation and playground is provided as part of onboarding.
  2. At least one user set up: You will sign in to the documentation and playground using your email address and password.

The API docs are the source of truth for endpoint paths, request and response schemas, and example payloads. Each link below opens the version-specific documentation in a new tab.

If you are starting a new integration, use v2 together with non-legacy pairing. Use v1 only if you are maintaining an existing integration that already depends on it.

Once onboarding is complete and at least one user has been configured, you can sign in to the relevant API version using your email address and password and use the playground from there.

VersionName
V1Integrated API v1
V2Integrated API v2