Get a pull request

curl --request GET \
  --url https://api.trunk.io/v2/pull-requests/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.trunk.io/v2/pull-requests/{id}', 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/v2/pull-requests/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.trunk.io/v2/pull-requests/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.trunk.io/v2/pull-requests/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "repositoryId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "number": 4901,
  "title": "feat: terminate /v2 at the gateway",
  "branch": "phil/implement-remaining-apis",
  "sha": "9c58bf40e5c1a2b3d4e5f60718293a4b5c6d7e8f",
  "baseBranch": "main",
  "author": "octocat",
  "isCurrentlySubmittedToQueue": true,
  "createdAt": "2026-07-28T10:55:00.000Z",
  "url": "https://github.com/acme/widgets/pull/4901",
  "state": "open",
  "queueEntry": {
    "id": "6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f",
    "mergeQueueId": "xK9mP2nQ",
    "state": "testing",
    "stateChangedAt": "2026-07-28T11:40:02.000Z",
    "skipsTheLine": false,
    "allowBatching": true,
    "direct": false,
    "readiness": {
      "requiresImpactedTargets": true,
      "doesBaseBranchMatch": true,
      "mergeability": "mergeable",
      "hasImpactedTargets": true,
      "mergeabilityDetails": {
        "provider": "github",
        "reasons": [
          {
            "code": "reviewRequired",
            "message": "needs 1 more approving review",
            "have": 0,
            "need": 1
          }
        ]
      }
    },
    "createdAt": "2026-07-28T11:02:31.000Z",
    "updatedAt": "2026-07-28T11:40:02.000Z",
    "priorityValue": 100,
    "priorityName": "high",
    "usedDefaultPriorityName": "medium",
    "verifiedByVerificationRunId": "a1b2c3d4-e5f6-4718-9a0b-1c2d3e4f5061"
  },
  "htmlUrl": "https://app.trunk.io/acme/pull/4901?repo=1a2b3c4d",
  "viewerIsAuthor": true,
  "ci": {
    "headSha": "a0de7a77e8d758a346f83ed19209a5a25814bb17",
    "observedAt": "2026-09-29T15:12:25.000Z",
    "pollAfterSeconds": 10,
    "jobs": {
      "total": 209,
      "queued": 0,
      "running": 0,
      "passed": 110,
      "failed": 2,
      "cancelled": 0,
      "skipped": 97,
      "abandoned": 0
    },
    "jobsUrl": "/v2/ci-jobs?pullRequestId=0f8fad5b-d9cb-469f-a165-70867728950e&commitSha=a0de7a77e8d758a346f83ed19209a5a25814bb17",
    "workflowRunsUrl": "/v2/ci-workflow-runs?pullRequestId=0f8fad5b-d9cb-469f-a165-70867728950e&commitSha=a0de7a77e8d758a346f83ed19209a5a25814bb17"
  }
}

Pull requests

Get a pull request

Returns one pull request: its queue entry and readiness if it has ever been submitted to a queue, and ci, the head commit’s CI jobs counted with the URLs of the lists. ci.pollAfterSeconds says when to read the head commit’s CI again; it is null once nothing on that commit will change, even while the queue entry is still live, so to wait for a merge keep polling until queueEntry.state is merged, failed, or cancelled. A request that sends the last ETag in If-None-Match gets 304 when nothing changed.

GET

pull-requests

{id}

Get a pull request

curl --request GET \
  --url https://api.trunk.io/v2/pull-requests/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.trunk.io/v2/pull-requests/{id}', 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/v2/pull-requests/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.trunk.io/v2/pull-requests/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.trunk.io/v2/pull-requests/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "repositoryId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "number": 4901,
  "title": "feat: terminate /v2 at the gateway",
  "branch": "phil/implement-remaining-apis",
  "sha": "9c58bf40e5c1a2b3d4e5f60718293a4b5c6d7e8f",
  "baseBranch": "main",
  "author": "octocat",
  "isCurrentlySubmittedToQueue": true,
  "createdAt": "2026-07-28T10:55:00.000Z",
  "url": "https://github.com/acme/widgets/pull/4901",
  "state": "open",
  "queueEntry": {
    "id": "6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f",
    "mergeQueueId": "xK9mP2nQ",
    "state": "testing",
    "stateChangedAt": "2026-07-28T11:40:02.000Z",
    "skipsTheLine": false,
    "allowBatching": true,
    "direct": false,
    "readiness": {
      "requiresImpactedTargets": true,
      "doesBaseBranchMatch": true,
      "mergeability": "mergeable",
      "hasImpactedTargets": true,
      "mergeabilityDetails": {
        "provider": "github",
        "reasons": [
          {
            "code": "reviewRequired",
            "message": "needs 1 more approving review",
            "have": 0,
            "need": 1
          }
        ]
      }
    },
    "createdAt": "2026-07-28T11:02:31.000Z",
    "updatedAt": "2026-07-28T11:40:02.000Z",
    "priorityValue": 100,
    "priorityName": "high",
    "usedDefaultPriorityName": "medium",
    "verifiedByVerificationRunId": "a1b2c3d4-e5f6-4718-9a0b-1c2d3e4f5061"
  },
  "htmlUrl": "https://app.trunk.io/acme/pull/4901?repo=1a2b3c4d",
  "viewerIsAuthor": true,
  "ci": {
    "headSha": "a0de7a77e8d758a346f83ed19209a5a25814bb17",
    "observedAt": "2026-09-29T15:12:25.000Z",
    "pollAfterSeconds": 10,
    "jobs": {
      "total": 209,
      "queued": 0,
      "running": 0,
      "passed": 110,
      "failed": 2,
      "cancelled": 0,
      "skipped": 97,
      "abandoned": 0
    },
    "jobsUrl": "/v2/ci-jobs?pullRequestId=0f8fad5b-d9cb-469f-a165-70867728950e&commitSha=a0de7a77e8d758a346f83ed19209a5a25814bb17",
    "workflowRunsUrl": "/v2/ci-workflow-runs?pullRequestId=0f8fad5b-d9cb-469f-a165-70867728950e&commitSha=a0de7a77e8d758a346f83ed19209a5a25814bb17"
  }
}

Authorizations

Authorization

string

header

required

An API key, sent as Authorization: Bearer <key>. An organization admin creates one in the Trunk app under Settings → Developer → API Keys and chooses the permissions it holds. A key with none can read merge queues but change nothing in them. Permissions cover merge queues and test-result uploads, including the quarantine lookups a CI run makes before it uploads; any key can call the other Flaky Tests and Dynamic CI endpoints, including their writes.

Path Parameters

string<uuid>

required

The pull request's id.

Example:

"0f8fad5b-d9cb-469f-a165-70867728950e"

Response

The pull request

A pull request Trunk has indexed. There is no nested repository object — resolve repositoryId with GET /v2/repositories/{id}.

string

required

Example:

"0f8fad5b-d9cb-469f-a165-70867728950e"

repositoryId

string

required

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

number

integer

required

Example:

4901

title

string

required

Example:

"feat: terminate /v2 at the gateway"

branch

string

required

Example:

"phil/implement-remaining-apis"

sha

string

required

The head commit of the pull request as Trunk last indexed it. Compare against a verification run's testedPullRequests[].sha to tell whether a run tested the current head or a superseded one — a mismatch means the branch moved after that run started.

Example:

"9c58bf40e5c1a2b3d4e5f60718293a4b5c6d7e8f"

baseBranch

string

required

The branch this pull request targets. Must match the queue's targetBranch to be enqueueable — readiness.doesBaseBranchMatch reports that check.

Example:

"main"

author

string

required

Example:

"octocat"

isCurrentlySubmittedToQueue

boolean

required

True when this pull request's queue entry is non-terminal.

Example:

true

createdAt

string<date-time>

required

Example:

"2026-07-28T10:55:00.000Z"

url

string

Omitted until the provider sync has populated it.

Example:

"https://github.com/acme/widgets/pull/4901"

state

enum<string>

The pull request's state at the provider, as Trunk last indexed it — not its queue state, which is QueueEntry.state.

Available options:

open,

closed,

merged

Example:

"open"

queueEntry

object

A pull request's queue membership. A pull request has at most one at a time, and resubmitting it to the same queue reuses this record. An entry the queue tears down is replaced, so a later submission can carry a different id and mergeQueueId.

Show child attributes

htmlUrl

string

The pull request's page in the Trunk web app. Absent when the repository has no keyed organization.

Example:

"https://app.trunk.io/acme/pull/4901?repo=1a2b3c4d"

viewerIsAuthor

boolean

Whether the authenticated user authored this pull request. Provided on the queue pull-request list (GET /merge-queues/{id}/pull-requests); absent elsewhere and when the caller is not a signed-in user.

Example:

true

object | null

CI on the head commit. Null when the repository has no CI data. Absent from lists, from a lookup of more than one pull request, and when the CI read failed.

Show child attributes