Cyclr

Cyclr Cycles API

Manage integration cycles

GitHub OpenAPI

Operations 5

GET /cycles Cyclr List Cycles #
GET /cycles/{cycleId} Cyclr Get Cycle #
DELETE /cycles/{cycleId} Cyclr Delete Cycle #
PUT /cycles/{cycleId}/activate Cyclr Activate Cycle #
PUT /cycles/{cycleId}/deactivate Cyclr Deactivate Cycle #

Documentation

📖
Documentation
https://cyclr.com
📖
APIReference
https://api.cyclr.com/docs/index

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cyclr/refs/heads/main/openapi/cyclr-cycles-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/cyclr/refs/heads/main/asyncapi/cyclr-cyclr-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cyclr/refs/heads/main/json-schema/cyclr-account.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cyclr/refs/heads/main/json-schema/cyclr-connector.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cyclr/refs/heads/main/json-schema/cyclr-installed-connector.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cyclr/refs/heads/main/json-schema/cyclr-template.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cyclr/refs/heads/main/json-schema/cyclr-cycle.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cyclr/refs/heads/main/json-schema/cyclr-step.json

Other Resources

🔗
APIDocumentation
https://docs.cyclr.com/api/
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/cyclr/refs/heads/main/json-ld/cyclr-context.jsonld
🔗
Rules
https://raw.githubusercontent.com/api-evangelist/cyclr/refs/heads/main/rules/cyclr-api-rules.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cyclr-cycles-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cyclr-cycles-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Cyclr Accounts Cycles API
  description: 'Cyclr''s REST API allows you to manage your Accounts and Cycles, as well as install Templates and Connectors. The 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 identify which Cyclr Account to execute the call against.'
  version: 1.0.0
  contact:
    name: Cyclr
    url: https://cyclr.com
  license:
    name: Proprietary
    url: https://cyclr.com/legal
servers:
- url: https://api.cyclr.com/v1.0
  description: Cyclr US API
- url: https://api.eu.cyclr.com/v1.0
  description: Cyclr EU API
- url: https://api.au.cyclr.com/v1.0
  description: Cyclr AU API
security:
- bearerAuth: []
tags:
- name: Cycles
  description: Manage integration cycles
paths:
  /cycles:
    get:
      operationId: listCycles
      summary: Cyclr List Cycles
      description: Retrieve a list of all cycles in the current account. Requires the X-Cyclr-Account header.
      tags:
      - Cycles
      parameters:
      - $ref: '#/components/parameters/xCyclrAccount'
      - name: page
        in: query
        schema:
          type: integer
        description: Page number for pagination
      - name: pageSize
        in: query
        schema:
          type: integer
        description: Number of results per page
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Cycle'
        '401':
          description: Unauthorized
  /cycles/{cycleId}:
    get:
      operationId: getCycle
      summary: Cyclr Get Cycle
      description: Retrieve details of a specific cycle. Requires the X-Cyclr-Account header.
      tags:
      - Cycles
      parameters:
      - $ref: '#/components/parameters/cycleId'
      - $ref: '#/components/parameters/xCyclrAccount'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cycle'
        '401':
          description: Unauthorized
        '404':
          description: Cycle not found
    delete:
      operationId: deleteCycle
      summary: Cyclr Delete Cycle
      description: Delete a specific cycle. Requires the X-Cyclr-Account header.
      tags:
      - Cycles
      parameters:
      - $ref: '#/components/parameters/cycleId'
      - $ref: '#/components/parameters/xCyclrAccount'
      responses:
        '200':
          description: Cycle deleted successfully
        '401':
          description: Unauthorized
        '404':
          description: Cycle not found
  /cycles/{cycleId}/activate:
    put:
      operationId: activateCycle
      summary: Cyclr Activate Cycle
      description: Activate a cycle so it begins running. Requires the X-Cyclr-Account header.
      tags:
      - Cycles
      parameters:
      - $ref: '#/components/parameters/cycleId'
      - $ref: '#/components/parameters/xCyclrAccount'
      responses:
        '200':
          description: Cycle activated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cycle'
        '401':
          description: Unauthorized
        '404':
          description: Cycle not found
  /cycles/{cycleId}/deactivate:
    put:
      operationId: deactivateCycle
      summary: Cyclr Deactivate Cycle
      description: Deactivate a running cycle. Requires the X-Cyclr-Account header.
      tags:
      - Cycles
      parameters:
      - $ref: '#/components/parameters/cycleId'
      - $ref: '#/components/parameters/xCyclrAccount'
      responses:
        '200':
          description: Cycle deactivated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cycle'
        '401':
          description: Unauthorized
        '404':
          description: Cycle not found
components:
  schemas:
    InstalledConnector:
      type: object
      properties:
        Id:
          type: integer
          description: Installed connector identifier
        Name:
          type: string
          description: Installed connector name
        Description:
          type: string
          description: Installed connector description
        ConnectorId:
          type: integer
          description: Reference to the base connector
        Authenticated:
          type: boolean
          description: Whether the connector has been authenticated
        Status:
          type: string
          description: Installation status
    Step:
      type: object
      properties:
        Id:
          type: string
          description: Unique step identifier
        Name:
          type: string
          description: Step name
        Description:
          type: string
          description: Step description
        ConnectorId:
          type: integer
          description: ID of the connector used by this step
        MethodId:
          type: string
          description: ID of the method called by this step
    Cycle:
      type: object
      properties:
        Id:
          type: string
          description: Unique cycle identifier
        Name:
          type: string
          description: Cycle name
        Description:
          type: string
          description: Cycle description
        Status:
          type: string
          description: Current cycle status
          enum:
          - Active
          - Inactive
          - Paused
          - Error
        CreatedDate:
          type: string
          format: date-time
          description: When the cycle was created
        LastRunDate:
          type: string
          format: date-time
          description: When the cycle last ran
        Connectors:
          type: array
          description: Connectors used by the cycle
          items:
            $ref: '#/components/schemas/InstalledConnector'
        Steps:
          type: array
          description: Steps in the cycle
          items:
            $ref: '#/components/schemas/Step'
  parameters:
    xCyclrAccount:
      name: X-Cyclr-Account
      in: header
      required: true
      schema:
        type: string
      description: The API ID of the Cyclr Account to execute the call against. Required for all Account level endpoints.
    cycleId:
      name: cycleId
      in: path
      required: true
      schema:
        type: string
      description: The unique identifier of the cycle
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 Bearer token obtained from the /oauth/token endpoint using Client Credentials flow with your Cyclr Console Client ID and Client Secret.