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.
This API exposes 4 JSON Schema definitions.
Tagged areas include Job. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 4 JSON Schemas.
This API exposes 4 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 2.0.
Requests are made against a single base URL, https://circleci.com/api/v2.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
CircleCI Job API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Circle-Token (apiToken).
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
apiToken— Personal API token for authenticating with the CircleCI API. Generate tokens in your CircleCI account settings.basicAuth— HTTP basic authentication using a personal API token as the username with an empty password.
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.
Endpoints for retrieving job details, artifacts, and test metadata associated with pipeline jobs.
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), TestList (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from CircleCI 12
Other APIs CircleCI publishes across the network.
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.