List pull request stacks | Sample

5 parameters

ownerstringrequired

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

repostringrequired

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

pull_requestintegeroptional

Filter to the stack containing this repository pull request number.

per_pageintegeroptional

The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."

Default:30

pageintegeroptional

The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."

Default:1

3 status codes

200Response

idintegerrequired

numberintegerrequired

node_idstringrequired

urlstringrequired

baseobjectrequired

openbooleanrequired

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

created_atstringrequired

pull_requestsarray<object>required

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

422Validation failed, or the endpoint has been spammed.

messagestringrequired

documentation_urlstringrequired

errorsarray<object>optional

Error handling

A 404 is returned: Resource not found. A 422 is returned: Validation failed, or the endpoint has been spammed.

import { Client } from "octri-github";

const client = new Client({
  baseUrl: "https://api.github.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.stacks.list({
  owner: "octocat",
  repo: "hello-world",
  pullRequest: "example",
  perPage: 20,
  page: 1,
});

[
  {
    "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"
  }
]

Was this helpful?

Request

Response

Errors