Get a merge queue

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

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

fetch('https://api.trunk.io/v2/merge-queues/{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/merge-queues/{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/merge-queues/{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/merge-queues/{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": "xK9mP2nQ",
  "repositoryId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "targetBranch": "main",
  "state": "running",
  "mode": "queue",
  "managedState": "manual",
  "createdAt": "2026-07-24T20:26:04.000Z",
  "updatedAt": "2026-07-28T11:02:31.000Z",
  "repositoryUrl": "https://github.com/acme/widgets",
  "pullRequestsUrl": "/v2/merge-queues/xK9mP2nQ/pull-requests",
  "config": {
    "concurrency": 5,
    "bisectionConcurrency": 0,
    "pendingFailureDepth": 3,
    "canOptimisticallyMerge": true,
    "allowBatching": false,
    "batchingMaxWaitTimeMinutes": 10,
    "batchingMinSize": 2,
    "testingTimeoutMinutes": 60,
    "notReadyTimeoutMinutes": 120,
    "createsPrsForTestingBranches": false,
    "areCommentsEnabled": true,
    "areCommandsEnabled": true,
    "isStatusCheckEnabled": true,
    "isExtensionEnabled": false,
    "areLabelCommandsEnabled": true,
    "areStateLabelsEnabled": true,
    "requiredStatuses": [
      "build",
      "lint"
    ],
    "allowedBotSubmitters": [
      "dependabot"
    ],
    "batchingRules": [
      {
        "targetPattern": "//db/migrations:*",
        "policy": "isolate"
      }
    ],
    "directMergeMode": "off",
    "optimizationMode": "off",
    "mergeMethod": "squash",
    "testBranchConstructionMode": "renameTempBranch",
    "enqueueingLabel": "trunk-merge"
  },
  "htmlUrl": "https://app.trunk.io/acme/merge-queue/xK9mP2nQ"
}

GET

merge-queues

{id}

Get a merge queue

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

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

fetch('https://api.trunk.io/v2/merge-queues/{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/merge-queues/{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/merge-queues/{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/merge-queues/{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": "xK9mP2nQ",
  "repositoryId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "targetBranch": "main",
  "state": "running",
  "mode": "queue",
  "managedState": "manual",
  "createdAt": "2026-07-24T20:26:04.000Z",
  "updatedAt": "2026-07-28T11:02:31.000Z",
  "repositoryUrl": "https://github.com/acme/widgets",
  "pullRequestsUrl": "/v2/merge-queues/xK9mP2nQ/pull-requests",
  "config": {
    "concurrency": 5,
    "bisectionConcurrency": 0,
    "pendingFailureDepth": 3,
    "canOptimisticallyMerge": true,
    "allowBatching": false,
    "batchingMaxWaitTimeMinutes": 10,
    "batchingMinSize": 2,
    "testingTimeoutMinutes": 60,
    "notReadyTimeoutMinutes": 120,
    "createsPrsForTestingBranches": false,
    "areCommentsEnabled": true,
    "areCommandsEnabled": true,
    "isStatusCheckEnabled": true,
    "isExtensionEnabled": false,
    "areLabelCommandsEnabled": true,
    "areStateLabelsEnabled": true,
    "requiredStatuses": [
      "build",
      "lint"
    ],
    "allowedBotSubmitters": [
      "dependabot"
    ],
    "batchingRules": [
      {
        "targetPattern": "//db/migrations:*",
        "policy": "isolate"
      }
    ],
    "directMergeMode": "off",
    "optimizationMode": "off",
    "mergeMethod": "squash",
    "testBranchConstructionMode": "renameTempBranch",
    "enqueueingLabel": "trunk-merge"
  },
  "htmlUrl": "https://app.trunk.io/acme/merge-queue/xK9mP2nQ"
}

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 merge-queue permissions it holds; a key with none can read merge queues but change nothing. Those permissions scope merge queue only: every key can use the Flaky Tests and Dynamic CI endpoints, including their writes, whatever permissions it holds.

Path Parameters

string

required

The merge queue's id.

Example:

"xK9mP2nQ"

Response

The merge queue

string

required

Example:

"xK9mP2nQ"

repositoryId

string

required

Resolve with GET /v2/repositories/{id}.

Example:

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

targetBranch

string

required

Example:

"main"

state

enum<string>

required

The queue's lifecycle state. switchingModes is a transient conversion state during which config and mode writes are refused.

Available options:

running,

paused,

draining,

switchingModes

Example:

"running"

mode

enum<string>

required

The engine a queue runs. queue tests entries in strict arrival order, one line. graph builds a dependency graph and may test entries speculatively in parallel, which merges faster but can require bisection to attribute a failure. Changing mode is a real conversion, not a flag flip — see mergeQueues.switchModes.

Available options:

queue,

graph

Example:

"queue"

managedState

enum<string>

required

Who owns the queue's configuration. terraform — the last write came from Terraform, identified on any queue write (create, config, pause/resume/drain, mode switch) by a User-Agent or X-Source header containing terraform or opentofu, case-insensitively — the same rule as v1. terraformWithDrift — Terraform owned it and a later write was not identified as Terraform's, so the live configuration may differ from the plan. Any such write counts, including pause/resume from other automation. manual — never written by Terraform.

Available options:

manual,

terraform,

terraformWithDrift

createdAt

string<date-time>

required

When the queue was created.

Example:

"2026-07-24T20:26:04.000Z"

updatedAt

string<date-time>

required

When the queue's own record last changed — its state or configuration. Not affected by entries moving through it.

Example:

"2026-07-28T11:02:31.000Z"

repositoryUrl

string

required

Absolute browsable URL of the repository at its provider (not a Trunk API URL).

Example:

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

pullRequestsUrl

string

required

Path — not an absolute URL — of this queue's pull-request collection on the Trunk API. Resolve it against the server URL; do not fetch it as-is.

Example:

"/v2/merge-queues/xK9mP2nQ/pull-requests"

config

object

required

A queue's full configuration. Two fields are merge-protection controls rather than tuning knobs — requiredStatuses (what must pass) and allowedBotSubmitters (who may enqueue) — so treat write access to this object as security-relevant.

Show child attributes

htmlUrl

string

The queue's page in the Trunk web app. Absent when the repository has no keyed organization (no slug to address it by).

Example:

"https://app.trunk.io/acme/merge-queue/xK9mP2nQ"