CircleCI

Manage pipelines, workflows, and jobs with the CircleCI API.

Detail	Value
Category	CI/CD
Base URL	https://circleci.com/api/v2
Authentication	API Key
Endpoints	8
Connector key	circleci

Using CircleCI in a workflow

1. Go to Connections and click New Connection.
2. Pick CircleCI from the marketplace.
3. Enter your credentials (see Authentication above for what's expected).
4. In a workflow, drop an API Call node and select this connection.
5. Pick the operation you need from the Operation dropdown. The full list is below.

Available endpoints

Endpoint	Summary
GET /me	Get current user
GET /project/{project-slug}/pipeline	List pipelines
POST /project/{project-slug}/pipeline	Trigger a pipeline
GET /pipeline/{pipeline-id}	Get pipeline details
GET /pipeline/{pipeline-id}/workflow	List workflows
GET /workflow/{id}	Get workflow details
POST /workflow/{id}/cancel	Cancel a workflow
GET /workflow/{id}/job	List workflow jobs

Each endpoint is documented in full below. Use the outline on the right to jump to one.

GET /me

Get current user

Detail	Value
Operation ID	cicd.getCurrentUser
Method	GET
Path	/me

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your CircleCI connection from the Connection dropdown.
3. In the Operation dropdown, select cicd.getCurrentUser.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream CircleCI API reference.

GET /project/{project-slug}/pipeline

List pipelines

Detail	Value
Operation ID	cicd.listProjectPipelines
Method	GET
Path	/project/{project-slug}/pipeline

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your CircleCI connection from the Connection dropdown.
3. In the Operation dropdown, select cicd.listProjectPipelines.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream CircleCI API reference.

POST /project/{project-slug}/pipeline

Trigger a pipeline

Detail	Value
Operation ID	cicd.triggerPipeline
Method	POST
Path	/project/{project-slug}/pipeline

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your CircleCI connection from the Connection dropdown.
3. In the Operation dropdown, select cicd.triggerPipeline.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream CircleCI API reference.

GET /pipeline/{pipeline-id}

Get pipeline details

Detail	Value
Operation ID	cicd.getPipeline
Method	GET
Path	/pipeline/{pipeline-id}

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your CircleCI connection from the Connection dropdown.
3. In the Operation dropdown, select cicd.getPipeline.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream CircleCI API reference.

GET /pipeline/{pipeline-id}/workflow

List workflows

Detail	Value
Operation ID	cicd.listPipelineWorkflows
Method	GET
Path	/pipeline/{pipeline-id}/workflow

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your CircleCI connection from the Connection dropdown.
3. In the Operation dropdown, select cicd.listPipelineWorkflows.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream CircleCI API reference.

GET /workflow/{id}

Get workflow details

Detail	Value
Operation ID	cicd.getWorkflow
Method	GET
Path	/workflow/{id}

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your CircleCI connection from the Connection dropdown.
3. In the Operation dropdown, select cicd.getWorkflow.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream CircleCI API reference.

POST /workflow/{id}/cancel

Cancel a workflow

Detail	Value
Operation ID	cicd.cancelWorkflow
Method	POST
Path	/workflow/{id}/cancel

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your CircleCI connection from the Connection dropdown.
3. In the Operation dropdown, select cicd.cancelWorkflow.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream CircleCI API reference.

GET /workflow/{id}/job

List workflow jobs

Detail	Value
Operation ID	cicd.listWorkflowJobs
Method	GET
Path	/workflow/{id}/job

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your CircleCI connection from the Connection dropdown.
3. In the Operation dropdown, select cicd.listWorkflowJobs.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream CircleCI API reference.