View Categories

Introduction to the Cyclr API

1 min read

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 (provided as a Swagger page) to view available API endpints 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 LocationAPI DomainInteractive API Reference
my.cyclr.comhttps://api.cyclr.comUS API Reference
us2.cyclr.comhttps://api.us2.cyclr.comUS2 API Reference
my.cyclr.ukhttps://api.cyclr.ukUK API Reference
eu.cyclr.comhttps://api.eu.cyclr.comEU API Reference
Private Instancehttps://{your-api-instance}https://{your-api-instance}/docs/index

API Reference Authorization #

You can use your Cyclr account details to authenticate and work with all API endpoints directly within the API reference documentation.

  1. Expand the endpoint and select the OFF slider.
  2. In the new window, select either Basic auth or Request body from the dropdown.
  3. Enter the ClientID and Secret that you want to use to authenticate.
  4. Select Authorize.

Cyclr supports OAuth authentication. For more information, see the API authentication documentation.

Note: The Cyclr API is divided into two parts, the Partner Level and the Account Level, you can use the same OAuth token for both but account level methods require that the account ID header is included with the request.