Skip to main content
POST
/
getSubmittedPullRequest
Get a submitted pull request from a merge queue.
curl --request POST \
  --url https://api.trunk.io/v1/getSubmittedPullRequest \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '
{
  "repo": {
    "host": "<string>",
    "owner": "<string>",
    "name": "<string>"
  },
  "pr": {
    "number": 2147483647
  },
  "targetBranch": "<string>"
}
'
{
  "stateChangedAt": "<string>",
  "priorityValue": 123,
  "priorityName": "<string>",
  "skipTheLine": true,
  "forceEnqueued": true,
  "isCurrentlySubmittedToQueue": true,
  "prNumber": 123,
  "prTitle": "<string>",
  "prSha": "<string>",
  "prBaseBranch": "<string>",
  "prAuthor": "<string>",
  "id": "<string>",
  "readiness": {
    "requiresImpactedTargets": true,
    "doesBaseBranchMatch": true,
    "hasImpactedTargets": true
  },
  "usedDefaultPriorityName": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://trunk-4cab4936-sam-gutentag-flaky-tests-new-monitors.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-token
string
header
required

Body

application/json
​
repo
object
required
​
pr
object
required
​
targetBranch
string
required

Response

OK

​
stateChangedAt
string
required
​
priorityValue
number
required
​
priorityName
string
required
​
skipTheLine
boolean
required
​
forceEnqueued
boolean
required
​
isCurrentlySubmittedToQueue
boolean
required
​
prNumber
number
required
​
prTitle
string
required
​
prSha
string
required
​
prBaseBranch
string
required
​
prAuthor
string
required
​
id
string
​
state
enum<string>

The state of a pull request in the merge queue. See https://docs.trunk.io/merge-queue/using-the-queue/reference#pull-request-states for the full description of each state.

Available options:
not_ready,
pending,
testing,
tests_passed,
merged,
failed,
cancelled,
pending_failure
​
readiness
object

Readiness signals for a pull request in the merge queue. A PR can start testing when doesBaseBranchMatch is true, gitHubMergeability is mergeable, and (when requiresImpactedTargets is true) hasImpactedTargets is true.

​
usedDefaultPriorityName
string