Appearance

List Pull requests ​

Endpoint ​

http
GET /unified/ci-cd/pull-requests
Integrations supported
  • Bitbucket
  • Buddy
  • Gerrit
  • GitHub
  • GitLab

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_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

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
status
string

Either open, closed, or all to filter by state. Default is all.

All possible enum values:
  • all
  • closed
  • locked
  • merged
  • open
Enum support by integration
  • GitHub
    • open
    • closed
    • all
Supported in
  • GitHub
  • GitLab
title
string

The title of the pull request

Supported in
  • GitHub
  • GitLab
created_at
string · date-time

The date and time when the pull request was created

Supported in
  • GitLab
updated_at
string · date-time

The date and time when the pull request was last updated

Supported in
  • GitLab
sort_by
object

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

Supported in
  • GitHub
  • GitLab
created_at
string · date-time

The date and time when the pull request was created

All possible enum values:
  • asc
  • desc
Supported in
  • GitHub
  • GitLab
updated_at
string · date-time

The date and time when the pull request was last updated

All possible enum values:
  • asc
  • desc
Supported in
  • GitHub
  • GitLab
title
string

The title of the pull request

All possible enum values:
  • asc
  • desc
Supported in
  • GitLab
owner
string

The slug of the owner on Github.

Required in
  • GitHub
workspace
Required in
  • Buddy
repo
Required in
  • Bitbucket
  • Buddy
workspace_id
Required in
  • Bitbucket
filter_Query
object

Provide either raw or tokens; tokens use operator_value with the first underscore converted to a colon, and tokens containing :, spaces, quotes, or parentheses are used as is.

Supported in
  • Gerrit
raw
string

Full Gerrit q string.

tokens
string[]

List of shorthand tokens like status_open, project_test-yuvraj-repo, -is_wip.

Response Body ​

result
object[]

List of Pull requests

id
string
REQUIRED · 

The unique identifier for the pull request

Supported in
  • Bitbucket
  • Gerrit
  • GitHub
  • GitLab
title
string

The title of the pull request

Supported in
  • Bitbucket
  • Gerrit
  • GitHub
  • GitLab
number
integer

The number of the pull request

Supported in
  • Gerrit
  • GitHub
  • GitLab
description
object

The description of the pull request

Supported in
  • Bitbucket
  • GitHub
  • GitLab
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
  • Gerrit
  • GitHub
  • GitLab
base_branch
object

The base branch of the pull request

Supported in
  • Bitbucket
  • Gerrit
  • GitHub
  • GitLab
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
  • GitLab
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
  • Gerrit
  • GitHub
  • GitLab
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
  • GitLab
merged_at
string · date-time

The date and time when the pull request was merged

Supported in
  • GitHub
  • GitLab
created_at
string · date-time

The date and time when the pull request was created

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

The date and time when the pull request was last updated

Supported in
  • Bitbucket
  • Gerrit
  • GitHub
  • GitLab
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.