CircleCI REST API

The CircleCI API is a RESTful, fully-featured API that allows you to do almost anything in CircleCI. You can access all information and trigger all actions. The only thing we don’t provide access to is billing functions, which must be done from the CircleCI web UI.

Claim this API

Are you the operator of CircleCI REST API? Submit a claim to establish contact with us.

Report an Issue

Found something wrong with CircleCI REST API? Let us know about broken links, changed auth, deprecated endpoints, or other issues.

Base URL: https://circleci.com/api/v1
Auth: unknown
Endpoints: 9
Reachable: unknown
CORS: unknown

Endpoints

Method Path Summary Auth Last Status Latency
GET /project/{username}/{project}
GET /project/{username}/{project}/checkout-key
GET /project/{username}/{project}/checkout-key/{fingerprint}
GET /project/{username}/{project}/envvar
GET /project/{username}/{project}/envvar/{name}
GET /project/{username}/{project}/{build_num}
GET /project/{username}/{project}/{build_num}/artifacts
GET /project/{username}/{project}/{build_num}/tests
GET /projects
GET /recent-builds