---
title: 'CircleCI'
description: 'Manage pipelines, workflows, and jobs with the CircleCI API.'
---

# 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 — see the table below.

## Available Endpoints

| Endpoint | Summary |
|---|---|
| [GET /me](./get_me_cicd_getcurrentuser) | Get current user |
| [GET /project/{project-slug}/pipeline](./get_project_project_slug_pipeline_cicd_listprojectpipelines) | List pipelines |
| [POST /project/{project-slug}/pipeline](./post_project_project_slug_pipeline_cicd_triggerpipeline) | Trigger a pipeline |
| [GET /pipeline/{pipeline-id}](./get_pipeline_pipeline_id_cicd_getpipeline) | Get pipeline details |
| [GET /pipeline/{pipeline-id}/workflow](./get_pipeline_pipeline_id_workflow_cicd_listpipelineworkflows) | List workflows |
| [GET /workflow/{id}](./get_workflow_id_cicd_getworkflow) | Get workflow details |
| [POST /workflow/{id}/cancel](./post_workflow_id_cancel_cicd_cancelworkflow) | Cancel a workflow |
| [GET /workflow/{id}/job](./get_workflow_id_job_cicd_listworkflowjobs) | List workflow jobs |

> Each endpoint has its own page with parameter details, an example
> `API Call` node configuration, and the response shape.