Sign inGet started
Docs
Get started

CircleCI API Documentation

This is the complete API documentation for connecting to the CircleCI API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet CircleCI: CircleCI lets teams build, test, and deploy software with pipelines, workflows, jobs, contexts, organization controls, and deployment visibility through the CircleCI API v2. Keep reading to get started.

Quickstart

Before you run your first CircleCI request, you need three things:

  1. A MindCloud account — sign in or create an account at MindCloud.
  2. A MindCloud API Key — create one in API Keys. Keep it on your server.
  3. At least one CircleCI connection — create or choose one in Connections. Note its connectionId.

Every CircleCI action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/circleCI/latest/actions/{actionSlug}

You need a MindCloud API Key and a CircleCI connection. Then call an action such as Get Current User:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/circleCI/latest/actions/get-current-user" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your CircleCI account. See CircleCI API Authentication for the full flow and how to get your connection credentials.

CircleCI actions

All 94 published actions for this CircleCI version. Each page documents the endpoint, arguments, and response controls.

More IT Operations apps on the Universal API, behind the same REST shape. Or browse all apps.

GitHubNetlifyMySQLPostgreSQLFirebasePagerDutyGoogle Workspace AdminAdalo