Skip to main content
POST
List pull requests in a merge queue.

Authorizations

x-api-token
string
header
required

Body

application/json
repo
object
required
targetBranch
string
required

The target branch of the merge queue.

Example:

"main"

state
enum<string>

Optional filter for the state of pull requests. If not provided, pull requests of all states will be returned.

Available options:
not_ready,
pending,
testing,
tests_passed,
merged,
failed,
cancelled,
pending_failure
since
string<date-time>

Optional ISO 8601 timestamp. When provided, returns pull requests that concluded (merged, failed, or cancelled) since this time. Defaults to the beginning of time when only until is provided.

Example:

"2024-01-01T00:00:00Z"

until
string<date-time>

Optional ISO 8601 timestamp bounding the upper end of the concluded time range. When either since or until is provided, only pull requests that concluded (merged, failed, or cancelled) within the range are returned. Defaults to now.

Example:

"2024-02-01T00:00:00Z"

cursor
string<uuid>

Optional cursor for pagination. Use the nextCursor from the previous response.

take
integer
default:50

Number of pull requests to return (1-100). Defaults to 50.

Required range: 1 <= x <= 100

Response

OK

pullRequests
object[]
required

List of pull requests in the merge queue.

nextCursor
string<uuid>

Cursor for the next page of results. If absent, there are no more results.