Appearance

Get Pull requests ​

Endpoint ​

http
GET /unified/ci-cd/pull-requests/{id}
Integrations supported
  • Bitbucket
  • Buddy
  • GitHub

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.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
  • debug
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
workspace
Required in
  • Bitbucket
  • Buddy
repo
Required in
  • Bitbucket
  • Buddy
owner
string

The slug of the owner on Github.

Required in
  • GitHub
repo_id
string

The slug of the repository on Github.

Required in
  • GitHub

Response Body ​

id
string
REQUIRED · 

The unique identifier for the pull request

Supported in
  • Bitbucket
  • GitHub
title
string

The title of the pull request

Supported in
  • Bitbucket
  • GitHub
number
integer

The number of the pull request

Supported in
  • GitHub
description
object

The description of the pull request

Supported in
  • Bitbucket
  • GitHub
content
string

The content of the body

format
string

The format of the body

All possible enum values:
  • markdown
  • html
  • plaintext
status
string

The status of the pull request

All possible enum values:
  • open
  • closed
  • merged
  • locked
Supported in
  • Bitbucket
  • GitHub
base_branch
object

The base branch of the pull request

Supported in
  • Bitbucket
  • GitHub
id
string

The unique identifier for the base branch

name
string

The name of the base branch

last_commit
string

The last commit of the base branch

head_branch
object

The head branch of the pull request

Supported in
  • Bitbucket
  • GitHub
id
string

The unique identifier for the head branch

name
string

The name of the head branch

last_commit
string

The last commit of the head branch

author
object

The author of the pull request

Supported in
  • Bitbucket
  • GitHub
id
string

The unique identifier for the author

username
string

The username of the author

type
string

The type of the author

All possible enum values:
  • user
  • bot
closed_at
string · date-time

The date and time when the pull request was closed

Supported in
  • GitHub
merged_at
string · date-time

The date and time when the pull request was merged

Supported in
  • GitHub
created_at
string · date-time

The date and time when the pull request was created

Supported in
  • Bitbucket
  • GitHub
updated_at
string · date-time

The date and time when the pull request was last updated

Supported in
  • Bitbucket
  • GitHub
remote_data
object

Raw data returned from the remote API call.