Access the API Documentation
The documentation is available at api.re-leased.com in two formats:
ReDoc — a clean, three-pane layout with easy navigation. Best for reading and referencing API endpoints.
Swagger — an interactive interface where you can execute API calls directly within the documentation. Best for testing and exploring endpoints.
Both versions contain the same information, so choose whichever suits your workflow.
Requesting API Access
Before you request access, review the documentation to confirm the API supports what you want to build.
Read the API documentation.
Complete the access request form linked within the documentation. The developer or technical contact building the integration should complete this themselves, as the form captures the technical details needed to provision access.
We will confirm your access entitlement and provision your credentials.
API access is included with Enterprise subscriptions and is available as an add-on on Core and Pro subscriptions. If you are not sure what your subscription includes, your account manager can confirm before you request API access.
Getting Help with the API
Start with the API documentation. It covers authentication, available endpoints, request and response formats, and error codes, and it answers most questions that come up during a build.
If you are still stuck, contact our Support team the same way you would for any other Re-Leased question. To help us get you an answer quickly, include:
What you are trying to achieve
The endpoint you are calling
The request you sent, with credentials and personal data removed
The full response or error message, and the date and time it occurred
What our Support team can help with
Questions about API access, credentials and permissions
Clarifying how a documented endpoint behaves
Investigating unexpected API responses or errors
What sits with you
Designing, building and testing your integration
Writing, reviewing and debugging your own code
Maintaining and troubleshooting your integration over time
The API is a self-serve product intended to enable customers to develop against it independently. We provide support as outlined above but do not provide integration consulting or dedicated engineering support.
Building a Reliable Integration
A few things worth planning for before you start:
Protect your credentials. Store them securely and never expose them in client-side code or shared documents.
Handle errors and rate limits. Build in retries and logging so you can diagnose issues yourself.
Make sure someone can maintain it. Whoever builds your integration should be able to support and update it as your needs change.
Using AI tools
We do not currently support API access for AI assistants, AI agents, or MCP (Model Context Protocol) servers connecting directly to your Re-Leased data. The API was designed for traditional system-to-system integrations rather than the way AI agents query data, so pointing an AI agent at it today is unlikely to give you a good result. This is something we are actively considering for the future, and we would like to hear about your use case through our Support team or your Account Manager.
We also recommend against using AI coding tools to generate an integration end-to-end without an experienced developer being responsible for the result. Generated code often mishandles credentials, authentication flows, rate limits and error handling, which puts your data at risk and leaves you with an integration nobody on your team can debug. Integrations built this way fall outside what we can support.