Cyclr has its own REST API, allowing you to manage your Accounts and Cycles, as well as install Templates and Connectors.
You can use the interactive Cyclr API documentation page to view available API endpoints and parameters, as well as to help you test endpoints as you work with it.
API Domain and Reference Documentation #
Your Cyclr API Domain depends on the Cyclr Instance your Partner Console is hosted on:
| Cyclr Console Location | API Domain | Interactive API Reference |
|---|---|---|
| my.cyclr.com | https://api.cyclr.com | US API Reference |
| us2.cyclr.com | https://api.us2.cyclr.com | US2 API Reference |
| my.cyclr.uk | https://api.cyclr.uk | UK API Reference |
| eu.cyclr.com | https://api.eu.cyclr.com | EU API Reference |
| Private Instance | https://{your‑api‑instance} | https://{your‑api‑instance}/docs/index |
API Reference Authorization #
Note: The Cyclr API reference page has been updated in Release R25-10 (available from 14th October 2025). It’s visually quite different, but the actual Cyclr API has not been modified so still provides the same features.
Cyclr’s API uses OAuth authentication. For more information, see the API authentication documentation.
The Cyclr API is divided into two parts: Partner Level and Account Level. You can use the same OAuth Access Token for both, but Account level endpoints require an additional X-Cyclr-Account HTTP header to be included with the request, to identify which Cyclr Account to execute the call against.
Cyclr API Reference Walkthrough #
To view the Cyclr API reference page, you’ll need to know the Cyclr Instance your Console is hosted on, then use the table above to locate the “Interactive API Reference” page for it.
Once you’re viewing the Cyclr API reference page, you can run the “Authentication” call where you provide your Cyclr Console’s Client ID and Client Secret values, and that will obtain an Access Token which is then automatically available to all endpoints on the page.
- To do this, retrieve your Cyclr Console’s Client ID and Client Secret values and enter them in the fields shown in the screenshot above.
- Select the “Authorize” button to authenticate the page, enabling all endpoints to use an Access Token that’s returned.
You can scroll to any Cyclr API endpoint and select a particular “format” to view how that call could be coded, e.g. with a C# HttpClient, Go or Node.js.
You can also go on to execute a call by selecting the “Test Request” button:
Warning: Calls you make on this page to the Cyclr API are actually executed so can modify your Accounts, Cycles, etc.
After selecting any “Test Request” buttons, a popup will be displayed, giving you a complete view of the call and any HTTP Headers, Query Parameters and so on, that can be provided to the endpoint.
If you use tools such as Postman, this should be familiar to you.
If you have already run the “Authentication” endpoint on the page, an Access Token will be set in the top left, allowing you to select the “Send” button along the top to execute that call.
If not, you’ll see fields to provide your Cyclr Console’s Client ID and Client Secret to first generate one.
Once you’ve generated an Access Token on the page, it will automatically be used for other calls until you select the “Clear” button.
