How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CircleCI Job API

Endpoints for retrieving job details, artifacts, and test metadata associated with pipeline jobs.

CircleCI Job API is one of 18 APIs that CircleCI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Job. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.1.

Requests are made against a single base URL, https://circleci.com/api/v1.1.

4 operations 4 paths 7 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1
Base URL
https://circleci.com/api/v2
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

CircleCI Job API declares 1 security scheme for authenticating requests. An API key is passed in the header as Circle-Token (apiToken). By default, every request must be authenticated.

  • apiToken — Personal API token for authenticating with the CircleCI API. Can also be passed as a query parameter.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Job 4

Endpoints for retrieving job details, artifacts, and test metadata associated with pipeline jobs.

GET
/project/{project-slug}/job/{job-number}
Get job details
getJob 2 params → 200401404
POST
/project/{project-slug}/job/{job-number}/cancel
Cancel a job
cancelJob 2 params → 200401
GET
/project/{project-slug}/{job-number}/artifacts
List artifacts for a job
listJobArtifacts 2 params → 200401
GET
/project/{project-slug}/{job-number}/tests
List test metadata for a job
listJobTests 2 params → 200401

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Job (14 properties), TestMetadata (7 properties), Artifact (3 properties), ArtifactList (2 properties). Each schema is shown below with its type and property counts.

TestList
object
2 properties
MessageResponse
object
1 property
TestMetadata
object
7 properties
ArtifactList
object
2 properties
ErrorResponse
object
1 property
Job
object
14 properties
Artifact
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

circleci-job-api-openapi.yml Raw ↑

Other APIs CircleCI publishes across the network.

CircleCI Self-Hosted Runner API
CircleCI Webhooks
CircleCI Orbs Registry
CircleCI Artifact API
CircleCI Build API
CircleCI Context API
CircleCI Insights API
CircleCI Pipeline API
CircleCI Project API
CircleCI Resource Class API
CircleCI Runner Task API
CircleCI Schedule API
Where this information came from

This is an independent, third-party profile of CircleCI Job API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.