Skip to content
forgit api docs

List pull request stacks

GET
/repos/{owner}/{repo}/stacks

Lists pull request stacks in a repository.

API method documentation

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
owner
required
string

The account owner of the repository. The name is not case sensitive.

repo
required
string

The name of the repository without the .git extension. The name is not case sensitive.

Query Parameters

Section titled “Query Parameters”
pull_request
integer

Filter to the stack containing this repository pull request number.

per_page
integer
default: 30

The number of results per page (max 100). For more information, see “Using pagination in the REST API.”

page
integer
default: 1

The page number of the results to fetch. For more information, see “Using pagination in the REST API.”

Responses

Section titled “Responses”

200

Section titled “200”

Response

Media typeapplication/json
Array<object>
Pull Request Stack Minimal
object
id
required
integer
number
required
integer
node_id
required
string
url
required
string format: uri
base
required
object
ref
required
string
open
required

Whether the stack has any open pull request. False when all pull requests are merged or closed.

boolean
created_at
required
string format: date-time
pull_requests
required
Array<object>
object
number
required
integer
state
required
string
Allowed values: open closed
draft
required
boolean
merged_at
required
string format: date-time
nullable
head
required
object
ref
required
string
sha
required
string
Examples
Exampledefault
[
  {
    "id": 9876543,
    "number": 42,
    "node_id": "S_kwDOABCDEF4AAAAA",
    "url": "https://api.github.com/repos/octocat/hello-world/stacks/42",
    "base": {
      "ref": "main"
    },
    "pull_requests": [
      {
        "number": 101,
        "state": "open",
        "draft": false,
        "merged_at": null,
        "head": {
          "ref": "user-model",
          "sha": "aaa1111aaa1111aaa1111aaa1111aaa1111aaa11"
        }
      },
      {
        "number": 102,
        "state": "open",
        "draft": false,
        "merged_at": null,
        "head": {
          "ref": "user-api",
          "sha": "bbb2222bbb2222bbb2222bbb2222bbb2222bbb22"
        }
      }
    ],
    "open": true,
    "created_at": "2026-04-15T10:00:00Z"
  }
]

404

Section titled “404”

Resource not found

Media typeapplication/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Examplegenerated
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

422

Section titled “422”

Validation failed, or the endpoint has been spammed.

Media typeapplication/json
Validation Error

Validation Error

object
message
required
string
documentation_url
required
string
errors
Array<object>
object
resource
string
field
string
message
string
code
required
string
index
integer
value
One of:
string
nullable
Examplegenerated
{
  "message": "example",
  "documentation_url": "example",
  "errors": [
    {
      "resource": "example",
      "field": "example",
      "message": "example",
      "code": "example",
      "index": 1,
      "value": [
        "example"
      ]
    }
  ]
}