Using circleci-v2-sdk with circleci.com — TypeScript

Install

npm install circleci-v2-sdk

Quick start

import Circleci_v2_sdk from 'circleci-v2-sdk';

const client = new Circleci_v2_sdk({ apiKey: "YOUR_API_KEY" });

Provides information about the signed in user.

curl \
  # append ?circle-token=$API_KEY to the URL \
  https://circleci.com/api/v1/me

List of all the projects you're following on CircleCI, with build information…

curl \
  # append ?circle-token=$API_KEY to the URL \
  https://circleci.com/api/v1/projects

Build summary for each of the last 30 recent builds, ordered by build_num.

curl \
  # append ?circle-token=$API_KEY to the URL \
  https://circleci.com/api/v1/recent-builds

Other SDKs for circleci.com