List GitHub pull requests

listGitHubPullRequests lists pull requests with branch, state, sorting, and pagination filters.

automations/list-github-pull-requests.automation.ts

import { automation, onHttpRequest } from "automate.ax"
import { listGitHubPullRequests } from "automate.ax/github"

export default automation("List GitHub pull requests", () => {
  onHttpRequest({ scope: "automation" })
  listGitHubPullRequests({
    owner: "SentsCo",
    repository: "automate.ax",
    base: "main",
  })
})

owner and repository are required. Optional filters are base, head (owner:branch for forks), state ("open", "closed", or "all"; default "open"), sort ("created", "updated", "popularity", or "long-running"), and direction. page defaults to 1 and perPage defaults to 30 with a maximum of 100. Optional account defaults to the project binding. Inputs accept compatible signals. Returns a typed array of GitHub pull request summaries. Request another page while the returned page length equals perPage.

⌘I

Get started

Concepts

Reference

List GitHub pull requests