Interface PullRequestsParams

Query parameters accepted by GET /rest/api/latest/projects/{key}/repos/{slug}/pull-requests.

See

https://developer.atlassian.com/server/bitbucket/rest/v819/api-group-pull-requests/#api-api-latest-projects-projectkey-repos-repositoryslug-pull-requests-get

interface PullRequestsParams {
    at?: string;
    direction?: "INCOMING" | "OUTGOING";
    limit?: number;
    order?: "NEWEST" | "OLDEST" | "MODIFIED" | "CLOSED_DATE";
    start?: number;
    state?: "OPEN" | "DECLINED" | "MERGED" | "ALL";
}

Hierarchy (View Summary)

Properties

at? direction? limit? order? start? state?

Properties

Optionalat

at?: string

Filter by target branch ref (e.g., 'refs/heads/main')

Optionaldirection

direction?: "INCOMING" | "OUTGOING"

Filter by direction relative to the current user.

  • 'INCOMING' — pull requests targeting a branch the user owns
  • 'OUTGOING' — pull requests from branches the user owns

Optionallimit

limit?: number

Maximum number of results to return per page. Bitbucket default is 25, maximum is 1000.

Optionalorder

order?: "NEWEST" | "OLDEST" | "MODIFIED" | "CLOSED_DATE"

Sort order of results

Optionalstart

start?: number

0-based index of the first result to return. Use nextPageStart from the previous response to paginate forward.

Optionalstate

state?: "OPEN" | "DECLINED" | "MERGED" | "ALL"

Filter by state. Defaults to 'OPEN'. Use 'ALL' to retrieve pull requests in any state.

Settings

Member Visibility

On This Page

Properties