Skip to main content
GET
List pull requests

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

app_id
string
required

ID of the app.

Query Parameters

scope
enum<string>
default:mine

mine for your own open pull requests, merged for the ones merged into the base branch.

Available options:
mine,
merged
limit
integer
default:10

How many pull requests to return, from 1 to 100.

Required range: 1 <= x <= 100
cursor
string

next_cursor from the previous page. Send the same scope and limit with it.

branch_id
string

ID of the branch to work on, as returned by List branches. Omit it to work on the app's main branch.

Response

A page of pull requests.

items
PullRequestListItem · object[]
required

The pull requests on this page, most recently updated first.

Example:
total
integer
required

Number of matching pull requests in total, across every page.

Example:

1

base_branch
string
required

The branch the app was imported from. merged lists the pull requests merged into it.

Example:

"main"

next_cursor
string | null
required

Pass as cursor to get the next page, or null on the last page.

Example:

"gAAAAABn"