Skip to content
forgit api docs

Create a pull request stack

POST
/repos/{owner}/{repo}/stacks

Creates a stack from an ordered list of pull request numbers. Provide the pull request numbers from the bottom of the stack to the top. Each pull request’s base ref must match the previous pull request’s head ref.

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.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
pull_requests
required

An ordered list of pull request numbers forming the stack from bottom to top.

Array<integer>
>= 2 items <= 100 items
Examples
Exampledefault
{
  "pull_requests": [
    101,
    102,
    103
  ]
}

Responses

Section titled “Responses”

201

Section titled “201”

Response

Media typeapplication/json
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>
Pull Request Stack Pull Request
object
id
required
integer format: int64
number
required
integer
url
required
string
head
required
object
ref
required
string
sha
required
string
repo
required
object
id
required
integer format: int64
url
required
string
name
required
string
base
required
object
ref
required
string
sha
required
string
repo
required
object
id
required
integer format: int64
url
required
string
name
required
string
node_id
required
string
title
required
string
state
required
string
Allowed values: open closed
merged_at
required
string format: date-time
nullable
draft
required
boolean
html_url
required
string format: uri
user
required
Simple User

A GitHub user.

object
name
string
nullable
email
string
nullable
login
required
string
id
required
integer format: int64
node_id
required
string
avatar_url
required
string format: uri
gravatar_id
required
string
nullable
url
required
string format: uri
html_url
required
string format: uri
followers_url
required
string format: uri
following_url
required
string
gists_url
required
string
starred_url
required
string
subscriptions_url
required
string format: uri
organizations_url
required
string format: uri
repos_url
required
string format: uri
events_url
required
string
received_events_url
required
string format: uri
type
required
string
site_admin
required
boolean
starred_at
string
user_view_type
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"
  },
  "open": true,
  "created_at": "2026-04-15T10:00:00Z",
  "pull_requests": [
    {
      "id": 100001,
      "node_id": "PR_kwDOABCDEF4AAAAA",
      "title": "Add user model",
      "state": "open",
      "merged_at": null,
      "draft": false,
      "html_url": "https://github.com/octocat/hello-world/pull/101",
      "user": {
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "",
        "url": "https://api.github.com/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://api.github.com/users/octocat/followers",
        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
        "organizations_url": "https://api.github.com/users/octocat/orgs",
        "repos_url": "https://api.github.com/users/octocat/repos",
        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
        "received_events_url": "https://api.github.com/users/octocat/received_events",
        "type": "User",
        "site_admin": false,
        "user_view_type": "public"
      },
      "number": 101,
      "url": "https://api.github.com/repos/octocat/hello-world/pulls/101",
      "head": {
        "ref": "user-model",
        "sha": "aaa1111aaa1111aaa1111aaa1111aaa1111aaa11",
        "repo": {
          "id": 1296269,
          "url": "https://api.github.com/repos/octocat/hello-world",
          "name": "hello-world"
        }
      },
      "base": {
        "ref": "main",
        "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
        "repo": {
          "id": 1296269,
          "url": "https://api.github.com/repos/octocat/hello-world",
          "name": "hello-world"
        }
      }
    },
    {
      "id": 100002,
      "node_id": "PR_kwDOABCDEF4AAAAB",
      "title": "Add user API",
      "state": "open",
      "merged_at": null,
      "draft": true,
      "html_url": "https://github.com/octocat/hello-world/pull/102",
      "user": {
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "",
        "url": "https://api.github.com/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://api.github.com/users/octocat/followers",
        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
        "organizations_url": "https://api.github.com/users/octocat/orgs",
        "repos_url": "https://api.github.com/users/octocat/repos",
        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
        "received_events_url": "https://api.github.com/users/octocat/received_events",
        "type": "User",
        "site_admin": false,
        "user_view_type": "public"
      },
      "number": 102,
      "url": "https://api.github.com/repos/octocat/hello-world/pulls/102",
      "head": {
        "ref": "user-api",
        "sha": "bbb2222bbb2222bbb2222bbb2222bbb2222bbb22",
        "repo": {
          "id": 1296269,
          "url": "https://api.github.com/repos/octocat/hello-world",
          "name": "hello-world"
        }
      },
      "base": {
        "ref": "user-model",
        "sha": "aaa1111aaa1111aaa1111aaa1111aaa1111aaa11",
        "repo": {
          "id": 1296269,
          "url": "https://api.github.com/repos/octocat/hello-world",
          "name": "hello-world"
        }
      }
    }
  ]
}

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. Returned when the request references pull requests that don’t exist in the repository, or when the pull requests can’t form a valid stack.

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
Examples

One or more pull request numbers don't exist in the repository

{
  "message": "Validation Failed",
  "documentation_url": "https://docs.github.com/rest/pulls/stacks#create-a-pull-request-stack",
  "errors": [
    {
      "resource": "Stack",
      "field": "pull_requests",
      "code": "missing",
      "value": [
        123
      ]
    }
  ]
}