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>"
}
'import requests
url = "https://api.trunk.io/v1/getSubmittedPullRequest"
payload = {
"repo": {
"host": "<string>",
"owner": "<string>",
"name": "<string>"
},
"pr": { "number": 2147483647 },
"targetBranch": "<string>"
}
headers = {
"x-api-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
repo: {host: '<string>', owner: '<string>', name: '<string>'},
pr: {number: 2147483647},
targetBranch: '<string>'
})
};
fetch('https://api.trunk.io/v1/getSubmittedPullRequest', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.trunk.io/v1/getSubmittedPullRequest",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'repo' => [
'host' => '<string>',
'owner' => '<string>',
'name' => '<string>'
],
'pr' => [
'number' => 2147483647
],
'targetBranch' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.trunk.io/v1/getSubmittedPullRequest"
payload := strings.NewReader("{\n \"repo\": {\n \"host\": \"<string>\",\n \"owner\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"pr\": {\n \"number\": 2147483647\n },\n \"targetBranch\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.trunk.io/v1/getSubmittedPullRequest")
.header("x-api-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"repo\": {\n \"host\": \"<string>\",\n \"owner\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"pr\": {\n \"number\": 2147483647\n },\n \"targetBranch\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trunk.io/v1/getSubmittedPullRequest")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"repo\": {\n \"host\": \"<string>\",\n \"owner\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"pr\": {\n \"number\": 2147483647\n },\n \"targetBranch\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
}"<string>""<string>""<string>""<string>"Pull Request Endpoints
Get a submitted pull request from a merge queue.
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>"
}
'import requests
url = "https://api.trunk.io/v1/getSubmittedPullRequest"
payload = {
"repo": {
"host": "<string>",
"owner": "<string>",
"name": "<string>"
},
"pr": { "number": 2147483647 },
"targetBranch": "<string>"
}
headers = {
"x-api-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
repo: {host: '<string>', owner: '<string>', name: '<string>'},
pr: {number: 2147483647},
targetBranch: '<string>'
})
};
fetch('https://api.trunk.io/v1/getSubmittedPullRequest', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.trunk.io/v1/getSubmittedPullRequest",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'repo' => [
'host' => '<string>',
'owner' => '<string>',
'name' => '<string>'
],
'pr' => [
'number' => 2147483647
],
'targetBranch' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.trunk.io/v1/getSubmittedPullRequest"
payload := strings.NewReader("{\n \"repo\": {\n \"host\": \"<string>\",\n \"owner\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"pr\": {\n \"number\": 2147483647\n },\n \"targetBranch\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.trunk.io/v1/getSubmittedPullRequest")
.header("x-api-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"repo\": {\n \"host\": \"<string>\",\n \"owner\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"pr\": {\n \"number\": 2147483647\n },\n \"targetBranch\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trunk.io/v1/getSubmittedPullRequest")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"repo\": {\n \"host\": \"<string>\",\n \"owner\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"pr\": {\n \"number\": 2147483647\n },\n \"targetBranch\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
}"<string>""<string>""<string>""<string>"Authorizations
Body
application/json
Response
OK
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 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.
Show child attributes
Show child attributes
Was this page helpful?
Cancel a pull request in a merge queue.
Previous
Restart tests on a pull request in a merge queue.
Next
⌘I