Skip to content

CircleCI ​

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

DetailValue
CategoryCI/CD
Base URLhttps://circleci.com/api/v2
AuthenticationAPI Key
Endpoints8
Connector keycircleci

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 ​

EndpointSummary
GET /meGet current user
GET /project/{project-slug}/pipelineList pipelines
POST /project/{project-slug}/pipelineTrigger a pipeline
GET /pipeline/{pipeline-id}Get pipeline details
GET /pipeline/{pipeline-id}/workflowList workflows
GET /workflow/{id}Get workflow details
POST /workflow/{id}/cancelCancel a workflow
GET /workflow/{id}/jobList workflow jobs

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