Automate the software development process using continuous integration and continuous delivery
Last verified: November 12, 2026
100% uptime: the documentation responded in 5 of 5 checks over the last 30 days. Median response time: 454 ms.
From CircleCI's OpenAPI specification (version v1), spec updated June 21, 2021, via APIs.guru.
The CircleCI API is a RESTful, fully-featured API that allows you to do almost anything in CircleCI. You can access all information and trigger all actions. The only thing we don’t provide access to is billing functions, which must be done from the CircleCI web UI.
Buy me a coffee
https://circleci.com/api/v1| Method | Path | What it does |
|---|---|---|
| GET | /me | Provides information about the signed in user. |
| GET | /project/{username}/{project} | Build summary for each of the last 30 builds for a single git repo. |
| POST | /project/{username}/{project} | Triggers a new build, returns a summary of the build. |
| DELETE | /project/{username}/{project}/build-cache | Clears the cache for a project. |
| GET | /project/{username}/{project}/checkout-key | Lists checkout keys. |
| POST | /project/{username}/{project}/checkout-key | Creates a new checkout key. Only usable with a user API token. |
| GET | /project/{username}/{project}/checkout-key/{fingerprint} | Get a checkout key. |
| DELETE | /project/{username}/{project}/checkout-key/{fingerprint} | Delete a checkout key. |
| GET | /project/{username}/{project}/envvar | Lists the environment variables for :project |
| POST | /project/{username}/{project}/envvar | Creates a new environment variable |
| GET | /project/{username}/{project}/envvar/{name} | Gets the hidden value of environment variable :name |
| DELETE | /project/{username}/{project}/envvar/{name} | Deletes the environment variable named ':name' |
| POST | /project/{username}/{project}/ssh-key | Create an ssh key used to access external systems that require SSH key-based authentication |
| POST | /project/{username}/{project}/tree/{branch} | Triggers a new build, returns a summary of the build. Optional build parameters can be set using an experimental API. |
| GET | /project/{username}/{project}/{build_num} | Full details for a single build. The response includes all of the fields from the build summary. |
| GET | /project/{username}/{project}/{build_num}/artifacts | List the artifacts produced by a given build. |
| POST | /project/{username}/{project}/{build_num}/cancel | Cancels the build, returns a summary of the build. |
| POST | /project/{username}/{project}/{build_num}/retry | Retries the build, returns a summary of the new build. |
| GET | /project/{username}/{project}/{build_num}/tests | Provides test metadata for a build Note: Learn how to set up your builds to collect test metadata |
| GET | /projects | List of all the projects you're following on CircleCI, with build information organized by branch. |
| GET | /recent-builds | Build summary for each of the last 30 recent builds, ordered by build num. |
| POST | /user/heroku-key | Adds your Heroku API key to CircleCI, takes apikey as form param name. |