merge_queue

Get a pull request in the merge queue

Changed on

Get details about a specific pull request in the merge queue

get/repos/{owner}/{repository}/merge-queue/pull/{pr_number}

Request

  • Base URL: https://api.mergify.com/v1
  • URL: https://api.mergify.com/v1/repos/{owner}/{repository}/merge-queue/pull/{pr_number}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

pr_numberinteger required

The pull request number

repositorystring required

The name of the repository

ownerstring required

The owner of the repository

Response

Successful Response

numberinteger required

The number of the pull request

queued_atstring date-time required

The timestamp when the pull request entered the queue

estimated_time_of_mergestring date-time nullable required

The estimated timestamp when this pull request will be merged

positioninteger required

The position of the pull request in the queue (0-indexed)

priority_rule_namestring required

The name of the priority rule applied to this pull request

queue_rule_namestring required

The name of the queue rule

checks_timeout_atstring date-time nullable required

When the checks of this pull request's batch will time out. Null when no checks timeout applies, while no checks run (before they first start, and until a new draft's start), and once they concluded: the time the batch waits does not count. Checks that read pending again, or start over on an edit to the batch branch or a new draft, get a whole timeout from then.

Changes

  • f0fe01773ba8Revision changes
    • warning

      added the new TEST_STATE_OVERLAP enum value to the response property for the response status

  • 24834a2d3673Revision changes
    • info

      removed the REPOSITORY_NOT_RECORDED enum value from the response property for the response status