CircleCI

The CircleCI API makes it easier and more efficient to run your CI/CD pipelines. Here you'll find information on how to make API calls, use API v1 and v2, monitor triggered pipelines, and set up flaky test detection.

Why am I getting the log in error on calling CircleCI APIs?

How to programmatically manage the "Setup Workflows" setting

Best Practices for Making API Calls to CircleCI Through a Script

Why Do I Get Random 403 Errors When Making API Calls with Google Scripts?

How to rotate GitHub Checkout Keys via the API

times_flaked: definition and timeframe

How to Pause an External Service Workflow and Manually Re-Trigger Continuation Using API

Monitor Status of Triggered Pipeline

CircleCI API v2 Returns "404 Not Found"

How to Get Information About Flaky and Slowest Tests via the Insights API

Why Are Environment Variables from My Context Not Found?

Messages Key from the CircleCI v2 Job Details Endpoint

Using 'Basic' Authentication in CircleCI API Calls

How to Trigger a Workflow via CircleCI API v2

Trigger Pipelines on Forked Pull Requests with CircleCI API v2

Troubleshooting why API Pipeline Parameters Do Not Work

How to get Job details with the CircleCI API V2

How to trigger a single job with version 2.1 config

How to mass unfollow projects from CircleCI

Find all Organization Projects via the CircleCI API

Troubleshooting "An internal server error occurred": Create User Keys with the API

CircleCI API Access

General

How to Find Your User ID via the v1 API

How to allowlist additional branches for Only Build Pull Requests

Setting Project API Features

API v1

Why do my API workflow metrics not match the CircleCI UI?

Who Approved My Approval Job?

Triggering CircleCI Builds on New Branches via API

Maximizing Value with CircleCI Usage Reports

Resolving "Malformed request body" Error in CircleCI Usage Export API

How to use the CircleCI v2 API to create and retrieve  usage reports

Usage API Creates an Invalid Download URL

How to add Datadog webhooks to your project using the API

How can I run a scheduled pipeline on a changing branch?

How can I dynamically select branches for a scheduled pipeline?

Retrieve Build Data via the API

How to cancel a job using the Cancel Job API

API v2

Status

Developer Hub

What's new

Find answers and get help from Intercom Support and Community Experts

Conversations you've started through the messenger will appear here.

No conversations created by you

Try using different keywords or checking for typos.

No conversations found

Title

This site employs cookies and other technologies that we and our third party vendors use to monitor and record personal information about you and your interactions with the site (including content viewed, cursor movements, screen recordings, and chat contents) for the purposes described in our Cookie Policy. By continuing to visit our site, you agree to our {websiteTermsLink}, {privacyPolicyLink} and {cookiePolicyLink}.

This site uses cookies and similar technologies ("cookies") as strictly necessary for site operation. We and our partners also would like to set additional cookies to enable site performance analytics, functionality, advertising and social media features. See our {cookiePolicyLink} for details. You can change your cookie preferences in our Cookie Settings.

We use cookies to make our site work and also for analytics and advertising purposes. You can enable or disable optional cookies as desired. See our {cookiePolicyLink} for more details.

Advertising cookies are set by our advertising partners to collect information about your use of the site, our communications, and other online services over time and with different browsers and devices. They use this information to show you ads online that they think will interest you and measure the ads' performance. Social media cookies are set by social media platforms to enable you to share content on those platforms, and are capable of tracking information about your activity across other online services for use as described in their privacy policies.

These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.

These cookies are necessary for the website to function and cannot be switched off in our systems.

These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site.

You have the right to opt out of the sale of your personal information. See our {cookiePolicyLink} for more details about how we use your data.

Your Privacy Choices

We use cookies to enhance your experience. You can customize your cookie preferences below. See our {cookiePolicyLink} for more details.

Cookie Settings

Empty Help Center

Uh oh. That page doesn’t exist.

Home

Search results

Disappointed

Neutral

Smiley

Thinking...

Searching through sources...

Analyzing...

Tickets submitted through the messenger or by a support agent in your conversation will appear here.

No tickets created by you

No tickets found

Track the progress of all tickets and conversations related to your company.

Customer Portal.

Track the progress of all tickets related to your company.

Tickets portal.

{assigneeName} needs more information from you

Tickets

No access to tickets portal

Search and ask

Find guides, answers, and references.

Skip the search. Describe what you’re trying to do and get a grounded answer.

Browse articles and guides in this topic.

Create your workspace and invite the people you work with.

Set up your account

Build your first workflow and watch it run end to end.

Ship something

Connect the tools your team already uses to bring data in.

Connect your stack

A quick lap of the product so you know where everything lives.

{appName} in 60 seconds

This prototype demo is aware that you are reading “{title}”. It can point you back to the current article, but a production article-aware Fin contract is still follow-up work.

Prototype article-aware answer

Because you already asked about invitations, this prototype demo can add the follow-up: use the role selector before sending each invite to limit access to the teammate responsibilities.

Prototype role-limiting follow-up

This prototype demo suggests starting with your workspace profile, inviting the team members who need access, and then connecting the integrations you use.

Prototype getting-started answer

In this prototype demo, integrations are configured from workspace settings. Choose the integration, connect the account, and review the enabled permissions.

Prototype integrations answer

In this prototype demo, invite teammates from workspace settings, then choose the access each teammate needs before sending the invitation.

Prototype invite-team answer

This prototype demo does not have a scripted answer for that question yet. Try asking how to invite your team or open a source article. No production Fin API was called.

Prototype answer unavailable

I’ve got this page open. Ask me anything about it and I’ll answer from the docs.