C

CircleCI API

by CircleCI Free tier

The CircleCI API v2 provides programmatic control over your CI/CD infrastructure. Trigger pipelines with custom parameters, query pipeline and workflow status, list and filter jobs, retrieve test metadata and artifacts, manage environment variables and contexts, and interact with orbs. Used for building custom deployment dashboards, automated release workflows, PR status bots, and infrastructure monitoring integrations.

ci-cdpipelinesbuildsworkflowstestingdeploymentautomation

Quick Reference

Base URL https://circleci.com/api/v2 Auth type API Key Header Auth header Circle-Token: YOUR_PERSONAL_API_TOKEN Rate limit 100 requests/min Pricing Pay per use Free quota 30,000 free credits/month (6,000 build minutes on small machines) Documentation https://circleci.com/docs/api/v2/ Endpoint status Server online — HTTP 404 — server is online but path returned an error (may require auth)746ms (checked Mar 29, 2026) Builder score B 68% builder-friendly
Pricing
75
Latency
38
Depth
86

Authentication

Generate a Personal API Token in CircleCI User Settings → Personal API Tokens. Pass it in the Circle-Token header.

Circle-Token: YOUR_PERSONAL_API_TOKEN

Pricing

Model pay-as-you-go Starting price Pay per use Free quota 30,000 free credits/month (6,000 build minutes on small machines)

Free: 30k credits/month. Performance $15/mo: 25k credits/month + $0.0006/credit. Scale: custom. Credits consumed per machine type and time (Linux small: 5 credits/min, large: 20 credits/min).

Key Endpoints

MethodPathDescription
POST /project/{project_slug}/pipeline Trigger a new pipeline for a project
GET /pipeline/{pipeline_id} Get pipeline details and status
GET /pipeline/{pipeline_id}/workflow List workflows in a pipeline
GET /workflow/{id}/job List jobs in a workflow
GET /project/{project_slug}/envvar List environment variables for a project
GET /insights/{project_slug}/workflows Get workflow performance insights and trends

Sample Request

curl "https://circleci.com/api/v2/project/github/myorg/myrepo/pipeline" \
  -H "Circle-Token: $CIRCLECI_TOKEN" \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{"branch":"main","parameters":{"deploy_env":"staging"}}'

Sample Response

{
  "id": "5034460f-c7a2-4c3c-b5c2-abc123456789",
  "number": 47,
  "state": "created",
  "created_at": "2024-03-15T10:00:00.000Z",
  "trigger": { "type": "api", "actor": { "login": "kevin" } }
}

Data sourced from API Map. Always verify pricing and rate limits against the official CircleCI documentation.