CircleCI

CI/CD platform: pipelines, workflows, jobs, artifacts, and build status events

CircleCI API referenceAPI checked August 18, 2026

Signs in with: Connection fields
Runs on: Cloud or On-Prem Worker
Operations: 111
Ready-made triggers: 0

Connect CircleCI

In Neblex open Connect › Connections and click New Connection.
Search for CircleCI and give the connection a clear name.
Fill in the fields. Secret values are encrypted and never shown again.
Click Test, then Create Connection.

Field	What to enter
API tokenRequiredSecret

Use it in a flow

Open a flow, open the node library and search for CircleCI.
Drag it onto the canvas and choose an Operation and your connection.
Map the operation's fields from earlier steps, or click Map with Matt.
Use Test this step to see what it returns, then save.

To start a flow from CircleCI without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if CircleCI can send webhooks, a Webhook trigger receives them at its own URL.

Operations

111 operations in 19 groups. Each one is a step you can add to a flow.

Context10

Add or update an environment variable`addEnvironmentVariableToContext`	PUT	Create or update an environment variable within a context.
Create a new context`createContext`	POST	Creates a new context in the specified organization.
Create context restriction`createContextRestriction`	POST	Creates project or expression restriction on a context.
Delete a context`deleteContext`	DELETE	Delete a context by its ID.
Delete context restriction`deleteContextRestriction`	DELETE	Deletes a project, expression or group restriction from a context.
Get a context`getContext`	GET	Returns basic information about a context.
Get context restrictions`getContextRestrictions`	GET	Gets a list of project and expression restrictions associated with a context.
List contexts`listContexts`	GET	List all contexts for an owner.
List environment variables`listEnvironmentVariablesFromContext`	GET	List information about environment variables in a context, not including their values.
Remove an environment variable`deleteEnvironmentVariableFromContext`	DELETE	Delete an environment variable from a context.

Deploy5

Get Component`getComponent`	GET	Get the details of a component by ID.
Get Environment`getEnvironment`	GET	Allows getting an environment for a given environment ID.
List Component Versions`listComponentVersions`	GET	List the versions for a component.
List Components`listComponents`	GET	Allows for listing of components for a given organization ID.
List Environments`listEnvironments`	GET	Allows listing environments for a given organization ID.

Group4

A group in an organization`getGroup`	GET	Get details for a group in an organization.
Create Groups`createOrganizationGroup`	POST	Create a new group under the organization.
Delete a group`deleteGroup`	DELETE	Delete a group in an organization.
Groups in an organization`getOrganizationGroups`	GET	Get all the groups in an organization.

Insight10

Get all branches for a project`getAllInsightsBranches`	GET	Get a list of all branches for a specified project.
Get flaky tests for a project`getFlakyTests`	GET	Get a list of flaky tests for a given project.
Get metrics and trends for workflows`getWorkflowSummary`	GET	Get the metrics and trends for a particular workflow on a single branch or all branches
Get recent runs of a workflow`getProjectWorkflowRuns`	GET	Get recent runs of a workflow.
Get summary metrics and trends for a project across it's`getProjectWorkflowsPageData`	GET	Get summary metrics and trends for a project at workflow and branch level.
Get summary metrics for a project workflow's jobs.`getProjectWorkflowJobMetrics`	GET	Get summary metrics for a project workflow's jobs.
Get summary metrics for a project's workflows`getProjectWorkflowMetrics`	GET	Get summary metrics for a project's workflows.
Get summary metrics with trends for the entire org, and for`getOrgSummaryData`	GET	Gets aggregated summary metrics with trends for the entire org.
Get test metrics for a project's workflows`getProjectWorkflowTestMetrics`	GET	Get test metrics for a project's workflows.
Job timeseries data`getJobTimeseries`	GET	Get timeseries data for all jobs within a workflow.

Job3

Cancel job by job ID`cancelJobByJobID`	POST	Cancel job with a given job ID.
Cancel job by job number`cancelJobByJobNumber`	POST	Cancel job with a given job number.
Get a job`getJob`	GET	Gets a job's metadata by its unique ID, including its name, job number, type, status, and associated resource IDs.

OIDC Token Management6

Delete org-level claims`DeleteOrgClaims`	DELETE	Deletes org-level custom claims of OIDC identity tokens
Delete project-level claims`DeleteProjectClaims`	DELETE	Deletes project-level custom claims of OIDC identity tokens
Get org-level claims`GetOrgClaims`	GET	Fetches org-level custom claims of OIDC identity tokens
Get project-level claims`GetProjectClaims`	GET	Fetches project-level custom claims of OIDC identity tokens
Patch org-level claims`PatchOrgClaims`	PATCH	Creates/Updates org-level custom claims of OIDC identity tokens
Patch project-level claims`PatchProjectClaims`	PATCH	Creates/Updates project-level custom claims of OIDC identity tokens

Organization6

Create a new organization`createOrganization`	POST	Create a new organization.
Create a new URL Orb allow-list entry`createURLOrbAllowListEntry`	POST	Create a new URL Orb allow-list entry
Delete an organization`deleteOrganization`	DELETE	Delete an organization.
Get an organization`getOrganization`	GET	Retrieve an organization by slug or ID
List the entries in the org's URL Orb allow-list`listURLOrbAllowListEntries`	GET	List the entries in the org's URL Orb allow-list
Remove an entry from the org's URL orb allow-list`removeURLOrbAllowListEntry`	DELETE	Remove an entry from the org's URL orb allow-list

OTel3

🧪 Create an OTLP exporter`createOtelExporter`	POST	[ EXPERIMENTAL ] Creates a new OTLP exporter configuration for the given organization.
🧪 Delete an OTLP exporter`deleteOtelExporter`	DELETE	[ EXPERIMENTAL ] Deletes an OTLP exporter configuration by ID.
🧪 List OTLP exporters`listOtelExporters`	GET	[ EXPERIMENTAL ] Returns a list of OTLP exporter configurations for the given organization.

Pipeline11

Continue a pipeline`continuePipeline`	POST	Continue a pipeline from the setup phase.
Get a list of pipelines`listPipelines`	GET	Returns all pipelines for the most recently built projects (max 250) you follow in an organization.
Get a pipeline by ID`getPipelineById`	GET	Returns a pipeline by the pipeline ID.
Get a pipeline by pipeline number`getPipelineByNumber`	GET	Returns a pipeline by the pipeline number.
Get a pipeline's configuration`getPipelineConfigById`	GET	Returns a pipeline's configuration by ID.
Get a pipeline's workflows`listWorkflowsByPipelineId`	GET	Returns a paginated list of workflows by pipeline ID.
Get all pipelines`listPipelinesForProject`	GET	Returns all pipelines for this project.
Get pipeline values for a pipeline`getPipelineValuesById`	GET	Returns a map of pipeline values by pipeline ID.
Get your pipelines`listMyPipelines`	GET	Returns a sequence of all pipelines for this project triggered by the user.
Recommended Trigger a new pipeline`triggerPipelineRun`	POST	Trigger a pipeline given a pipeline definition ID.
Trigger a new pipeline`triggerPipeline`	POST	This endpoint is superseded by the [new Trigger Pipeline API, which supports all organization and pipeline types except GitLab.] Triggers a new pipeline on the project.

Pipeline Definition5

Create pipeline definition`createPipelineDefinition`	POST	Create a pipeline definition for a given project.
Delete pipeline definition`deletePipelineDefinition`	DELETE	Delete pipeline definition.
Get pipeline definition`getPipelineDefinition`	GET	Get details for a pipeline definition.
List pipeline definitions`listPipelineDefinitions`	GET	List all pipeline definitions for a given project.
Update pipeline definition`updatePipelineDefinition`	PATCH	Update pipeline definition.

Policy Management9

Creates policy bundle for the context`CreatePolicyBundle`	POST	This endpoint replaces the current policy bundle with the provided policy bundle
Get the decision settings`GetDecisionSettings`	GET	This endpoint retrieves the current decision settings (eg enable/disable policy evaluation)
Makes a decision`MakeDecision`	POST	This endpoint will evaluate input data (config+metadata) against owner's stored policies and return a decision.
Retrieves a policy document`GetPolicyDocument`	GET	This endpoint will retrieve a policy document.
Retrieves Policy Bundle`GetPolicyBundle`	GET	This endpoint will retrieve a policy bundle
Retrieves Policy Bundle for a given decision log ID`GetDecisionLogPolicyBundle`	GET	This endpoint will retrieve a policy bundle for a given decision log ID
Retrieves the owner's decision audit log by given decisionID`GetDecisionLog`	GET	This endpoint will retrieve a decision for a given decision log ID
Retrieves the owner's decision audit logs.`GetDecisionLogs`	GET	This endpoint will return a list of decision audit logs that were made using this owner's policies.
Set the decision settings`SetDecisionSettings`	PATCH	This endpoint allows modifying decision settings (eg enable/disable policy evaluation)

Project13

Create a new checkout key`createCheckoutKey`	POST	Not available to projects that use GitLab or GitHub App.
Create a new project`createProject`	POST	Create a new project.
Create an environment variable`createEnvVar`	POST	Creates a new environment variable.
Delete a checkout key`deleteCheckoutKey`	DELETE	Deletes the checkout key via md5 or sha256 fingerprint.
Delete a project`deleteProjectBySlug`	DELETE	Deletes a project by project slug
Delete an environment variable`deleteEnvVar`	DELETE	Deletes the environment variable named :name.
Get a checkout key`getCheckoutKey`	GET	Returns an individual checkout key via md5 or sha256 fingerprint.
Get a masked environment variable`getEnvVar`	GET	Returns the masked value of environment variable :name.
Get a project`getProjectBySlug`	GET	Retrieves a project by project slug.
Get all checkout keys`listCheckoutKeys`	GET	Returns a sequence of checkout keys for :project.
Get project settings`getProjectSettings`	GET	Returns a list of the advanced settings for a CircleCI project, whether enabled (true) or not (false).
List all environment variables`listEnvVars`	GET	Returns four 'x' characters, in addition to the last four ASCII characters of the value, consistent with the display of environment variable values on the CircleCI website.
Update project settings`patchProjectSettings`	PATCH	Updates one or more of the advanced settings for a CircleCI project.

Rollback1

Rollback a projectrollbackProject POST Performs a rollback operation by triggering a rollback pipeline.

Schedule5

Create a schedule`createSchedule`	POST	Creates a schedule and returns the created schedule.
Delete a schedule`deleteScheduleById`	DELETE	Deletes a schedule by ID.
Get a schedule by ID. Available only on schedules associated`getScheduleById`	GET	Get a schedule by id.
List schedule triggers`listSchedulesForProject`	GET	For a given project, returns all schedules associated with GitHub OAuth or Bitbucket Cloud pipeline definitions.
Update a schedule`updateSchedule`	PATCH	Updates a schedule and returns the updated schedule.

Trigger5

Create trigger`createTrigger`	POST	Create a trigger for a given pipeline definition.
Delete trigger`deleteTrigger`	DELETE	Delete a trigger.
Get trigger`getTrigger`	GET	Get details for a trigger.
List pipeline definition triggers`listPipelineDefinitionTriggers`	GET	List all triggers for a given pipeline definition.
Update trigger`updateTrigger`	PATCH	Update a trigger.

Usage2

Create a usage export`createUsageExport`	POST	Submits a request to create a usage export for an organization.
Get a usage export`getUsageExport`	GET	Gets a usage export for an organization.

User3

Collaborations`getCollaborations`	GET	Provides the set of organizations of which a user is a member or a collaborator.
User Information`getCurrentUser`	GET	Provides information about the user that is currently signed in.
User Information`getUser`	GET	Provides information about the user with the given ID.

Webhook5

Create an outbound webhook`createWebhook`	POST	Creates an outbound webhook.
Delete an outbound webhook`deleteWebhook`	DELETE	Deletes an outbound webhook
Get a webhook`getWebhookById`	GET	Get an outbound webhook by id.
List webhooks`getWebhooks`	GET	Get a list of outbound webhooks that match the given scope-type and scope-id
Update an outbound webhook`updateWebhook`	PUT	Updates an outbound webhook.

Workflow5

Approve a job`approvePendingApprovalJobById`	POST	Approves a pending approval job in a workflow.
Cancel a workflow`cancelWorkflow`	POST	Cancels a running workflow.
Get a workflow`getWorkflowById`	GET	Returns summary fields of a workflow by ID.
Get a workflow's jobs`listWorkflowJobs`	GET	Returns a sequence of jobs for a workflow.
Rerun a workflow`rerunWorkflow`	POST	Reruns a workflow.