Appearance

Get Jobs ​

Endpoint ​

http
GET /unified/ci-cd/jobs/{id}
Integrations supported
  • Buddy
  • CircleCI
  • GitHub
  • Travis CI

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
owner

The slug of the owner on Github.

Required in
  • GitHub
repo_id

The slug of the repository on Github.

Required in
  • GitHub
project_slug

The project slug of the project on CircleCI. Its in the format vcs_provider/org_name/repo_name.

Required in
  • CircleCI
workspace
Required in
  • Buddy
project
Required in
  • Buddy
workflow
Required in
  • Buddy

Response Body ​

id
string
REQUIRED · 

The unique identifier for the job

Supported in
  • Buddy
  • CircleCI
  • GitHub
  • Travis CI
name
string

The name of the job

Supported in
  • Buddy
  • CircleCI
  • GitHub
  • Travis CI
build
string

The build of the job

Supported in
  • GitHub
  • Travis CI
status
string

The status of the job - queued, in_progress, completed or the raw response from the API

Supported in
  • Buddy
  • CircleCI
  • GitHub
  • Travis CI
conclusion
string

The conclusion of the job - passed, failed, cancelled, timeout, skipped, retried, partial or the raw response from the API

Supported in
  • CircleCI
  • GitHub
commit
string

The commit of the job

Supported in
  • GitHub
  • Travis CI
branch
string

The head branch of the job

Supported in
  • GitHub
attempts
integer

The number of attempts for the job

Supported in
  • GitHub
created_at
string · date-time

The date and time when the job was created

Supported in
  • CircleCI
  • GitHub
  • Travis CI
updated_at
string · date-time

The date and time when the job was last updated

Supported in
  • GitHub
  • Travis CI
started_at
string · date-time

The date and time when the job started

Supported in
  • Buddy
  • CircleCI
  • GitHub
  • Travis CI
completed_at
string · date-time

The date and time when the job completed

Supported in
  • CircleCI
  • GitHub
  • Travis CI
remote_data
object

Raw data returned from the remote API call.