Appearance

Get Branches ​

Endpoint ​

http
GET /unified/ci-cd/branches/{id}
Integrations supported
  • Bitbucket
  • Buddy
  • GitHub
  • GitLab
  • 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
repo_id
string
Integration specific notes
  • GitLabThe unique identifier for the repository
  • GitHubThe slug of the repository on Github.
Required in
  • GitHub
  • GitLab
owner

The slug of the owner on Github.

Required in
  • GitHub
workspace
Required in
  • Buddy
repo
string

The repository of the branch

Required in
  • Bitbucket
  • Buddy
workspace_id
Required in
  • Bitbucket

Response Body ​

id
string
REQUIRED · 

The unique identifier for the branch

Supported in
  • Bitbucket
  • Buddy
  • GitHub
  • GitLab
  • Travis CI
name
string
REQUIRED · 

Name of the branch

Supported in
  • Bitbucket
  • Buddy
  • GitHub
  • GitLab
  • Travis CI
repo
string

The repository of the branch

Supported in
  • Bitbucket
  • Buddy
  • GitHub
  • GitLab
  • Travis CI
last_commit
string

The last commit of the branch

Supported in
  • Bitbucket
  • Buddy
  • GitHub
  • GitLab
  • Travis CI
last_commit_by
string

The last commit author of the branch

Supported in
  • Bitbucket
  • Buddy
  • GitHub
  • GitLab
  • Travis CI
last_commit_message
string

The last commit message of the branch

Supported in
  • Bitbucket
  • Buddy
  • GitHub
  • GitLab
  • Travis CI
last_commit_at
string · date-time

The date and time when the last commit was made

Supported in
  • Bitbucket
  • Buddy
  • GitHub
  • GitLab
  • Travis CI
created_at
string · date-time

The date and time when the branch was created

Supported in
  • Buddy
  • Travis CI
updated_at
string · date-time

The date and time when the branch was last updated

Supported in
  • Buddy
remote_data
object

Raw data returned from the remote API call.