Skip to main content
GET
Get a build

Authorizations

Authorization
string
header
required

Generate an API token at https://qlty.sh/user/settings/tokens

Path Parameters

ownerKeyOrId
string
required

Repository owner name (login) or workspace ID

Minimum string length: 3
Example:

"acme-corp"

projectKeyOrId
string
required

Repository name or project ID

Minimum string length: 3
Example:

"my-repo"

buildId
string
required

Build ID

Minimum string length: 3
Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Retrieve the build

id
string
required
Example:

"550e8400-e29b-41d4-a716-446655440000"

type
enum<string>
required
Available options:
analysis,
format,
ssh,
coverage_setup
Example:

"analysis"

status
enum<string>
required

Most recent status reported for the build

Available options:
submitted,
starting,
running,
succeeded,
failed,
skipped,
rejected
Example:

"succeeded"

branchName
string | null
required
Example:

"main"

commitSha
string | null
required
Example:

"9c9a4c4a1e6bb01b2fbd7f5e1c0b4a2d3e5f6a7b"

commitMessage
string | null
required
Example:

"Fix the bug"

submittedAt
string<date-time>
required
Example:

"2026-01-01T12:00:00Z"

finishedAt
string<date-time> | null
required
Example:

"2026-01-01T12:01:35Z"

queueSeconds
integer | null
required
Example:

5

statusReason
string | null
required

Explanation for the current status, when one was reported

Example:

null

conclusion
enum<string> | null
required

Terminal outcome, or null while the build is unfinished

Available options:
succeeded,
failed
Example:

"succeeded"

exitCode
integer | null
required
Example:

0

source
string | null
required
Example:

"github_push"

pullRequestNumber
integer | null
required
Example:

42

committerLogin
string | null
required
Example:

"octocat"

startedAt
string<date-time> | null
required
Example:

"2026-01-01T12:00:05Z"

executionSeconds
integer | null
required
Example:

90