The API
ClearPath runs on a documented HTTP API. Every request body in the reference is generated from the same validation schemas the server enforces, so what it describes and what the server accepts cannot drift apart.
The reference
Interactive, with every endpoint, its failure responses and the exact shape of each request.
Browse the API referenceThe reference is served in development and is not always available in production — it is switched on deliberately rather than by default.
What it is not, yet
This documents the API this product runs on. It is not a partner integration: there are no service credentials to request and nothing to register. Calls are authenticated with the access token of somebody signed in to their own account, and can only reach what that person could reach in the interface.
If you want to build against this, that is worth hearing — but it is honest to say the programme does not exist rather than take a registration for one.