CircleCI REST API v1

REST discovered

Details Spec supplied by APIs.guru

URL: https://circleci.com/api/v1
Spec: https://api.apis.guru/v2/specs/circleci.com/v1/openapi.json
Docs: https://circleci.com/docs/guides/toolkit/api-intro/

Authentication

Personal API token api_key discovered Get key ↗

In the CircleCI app, open User settings, then Personal API Tokens, click Create New Token, give it a name, and click Add API Token. Copy the token when it is shown; CircleCI says you will not be able to view it again. The docs state personal API tokens are used to interact with CircleCI APIs v1 and v2, and the API developer guide says they are currently the only supported tokens on API v2.

Project API token api_key discovered Get key ↗

In the CircleCI app, go to your project's settings, select API Permissions, click Add API Token, choose a scope (Status, Read Only, or Admin), enter a label, and click Add API Token. The docs say project API tokens are for specific projects, and that Read Only and Admin project tokens apply to API v1 only while Status tokens are used for status badges.