Get build
GET
/builds/{id}Get details of a specific build
Example
Section titled “Example”Use resource IDs from your own project. Keep the API token in your server or CI environment.
import { createConfiguration, BuildsApi } from '@testcollab/sdk';
const config = createConfiguration(process.env.TESTCOLLAB_TOKEN!);const api = new BuildsApi(config);
const result = await api.getBuild({ "id": 123});console.log(result);curl --request GET \ "https://api.testcollab.io/builds/123?token=$TESTCOLLAB_TOKEN"Parameters
Section titled “Parameters”| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id |
path | number | Yes | Build ID |
Response
Section titled “Response”200 — Build details
| Field | Type | Required | Description |
|---|---|---|---|
id |
number | Yes | — |
version |
string | Yes | Human-facing version identifier of the software the tests run against |
environment |
string | No | Free-form environment name (e.g. Production, Staging, UAT) |
release_date |
string | No | — |
notes |
string | No | — |
release_notes_url |
string | No | — |
source |
string | Yes | How the build was created. manual is entered by a user; ci is ingested from a pipeline. Values: manual, ci. |
vcs_provider |
string | No | Registry key of the version-control provider (e.g. azure_devops, github, gitlab) |
ci_provider |
string | No | Registry key of the CI provider that produced the build |
commit_sha |
string | No | — |
branch |
string | No | — |
tag |
string | No | — |
repo_url |
string | No | — |
commit_url |
string | No | — |
build_number |
string | No | Provider build/run identifier (string — provider IDs are not always small ints) |
build_url |
string | No | — |
external_ref |
string | No | Opaque provider reference used to de-duplicate ingested builds |
metadata |
object | No | Provider-specific fields (Azure buildId/definitionId, GitHub run_id, GitLab pipeline_id, etc.) |
release |
Release Minified | No | Release this build is grouped under (). Auto-matched from the release’s version pattern, or assigned manually. |
release.id |
number | Yes | — |
release.name |
string | Yes | — |
release.status |
string | Yes | Values: planned, in_progress, ready, shipped, blocked. |
release.target_date |
string | No | — |
release.created_at |
string | No | — |
release_manual |
boolean | No | True when the build’s release was assigned manually — a manual assignment always overrides pattern auto-matching (). |
project |
number | Yes | — |
created_by |
User Minified | No | User who created a manual build. CI-ingested builds have no user and return null. |
created_by.id |
number | Yes | — |
created_by.username |
string | No | — |
created_by.name |
string | Yes | — |
created_by.avatar |
Upload | No | — |
created_by.avatar.id |
number | Yes | — |
created_by.avatar.name |
string | Yes | — |
created_by.avatar.hash |
string | Yes | — |
created_by.avatar.ext |
string | Yes | — |
created_by.avatar.mime |
string | Yes | — |
created_by.avatar.size |
string | Yes | — |
created_by.avatar.url |
string | Yes | — |
created_by.avatar.created_by |
number | No | — |
created_by.avatar.created_at |
string | Yes | — |
created_by.avatar.updated_at |
string | Yes | — |
created_by.is_guest |
number | No | — |
created_at |
string | Yes | — |
updated_at |
string | Yes | — |
{ "id": 123, "version": "example", "environment": "example", "release_date": "example", "notes": "example", "release_notes_url": "example", "source": "manual", "vcs_provider": "example", "ci_provider": "example"}Errors
Section titled “Errors”| Status | Meaning |
|---|---|
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not found |
500 |
Internal server error |