CircleCI REST API

circleci · Developer Tools

Developer Tools No Auth Free & Open developer_tools

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.

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET GET /me

Provides information about the signed in user.

https://api.apis.guru/v2/specs/circleci.com/v1/me

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/circleci.com/v1/me"

import requests
response = requests.get(
    "https://api.apis.guru/v2/specs/circleci.com/v1/me",
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/circleci.com/v1/me';

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.apis.guru/v2/specs/circleci.com/v1/me"
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/circleci.com/v1/me")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/circleci.com/v1/me";
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET GET /projects

List of all the projects you're following on CircleCI, with build information organized by branch.

https://api.apis.guru/v2/specs/circleci.com/v1/projects

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/circleci.com/v1/projects"

import requests
response = requests.get(
    "https://api.apis.guru/v2/specs/circleci.com/v1/projects",
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/circleci.com/v1/projects';

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.apis.guru/v2/specs/circleci.com/v1/projects"
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/circleci.com/v1/projects")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/circleci.com/v1/projects";
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET GET /recent-builds

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

https://api.apis.guru/v2/specs/circleci.com/v1/recent-builds?limit=30&offset=0

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/circleci.com/v1/recent-builds?limit=30&offset=0"

import requests
params = {
    "limit": "30",
    "offset": "0"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/circleci.com/v1/recent-builds",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/circleci.com/v1/recent-builds');
url.searchParams.set('limit', '30');
url.searchParams.set('offset', '0');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/circleci.com/v1/recent-builds")
	q := baseURL.Query()
	q.Set("limit", "30")
	q.Set("offset", "0")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/circleci.com/v1/recent-builds")
uri.query = URI.encode_www_form({
  "limit" => "30",
  "offset" => "0"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/circleci.com/v1/recent-builds?" . http_build_query([
    "limit" => "30",
    "offset" => "0"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with CircleCI REST API?

CircleCI REST API is a Developer Tools API. Developers commonly use developer tools APIs for:

automating code review and quality checks
integrating CI/CD pipelines and build systems
managing feature flags and A/B tests
monitoring errors and application performance
generating and validating test data

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. CircleCI REST API is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide · Learn about API keys · What is REST?

Open documentation ↗