---
title: "List pull requests"
method: GET
path: "/api/repos/{owner}/{repo}/pulls/"
tags: ["Pull Requests"]
---

# List pull requests

`GET /api/repos/{owner}/{repo}/pulls/`

## Request

- Base URL: `https://git.cafe`
- URL: `https://git.cafe/api/repos/{owner}/{repo}/pulls/`
- Auth: one of:
  - none
  - API key in cookie `gc-session`
  - HTTP bearer
  - HTTP basic
  - HTTP token
  - OAuth 2
    - Authorization code: `/api/oauth/authorize`
    - Token URL: `/api/oauth/token` scopes: `pr:contents:read`

List pull requests. Public repositories allow anonymous reads; supplied credentials are validated and may expand access to private resources.

## Path parameters

- `owner` string, required
- `repo` string, required

## Query parameters

- `after` string
- `limit` integer
- `state` 'open' | 'closed' | 'merged'
- `q` string
- `sort` 'newest' | 'oldest'
- `states` string
- `stateNots` string
- `authors` string
- `authorNots` string
- `assignees` string
- `assigneeNots` string
- `reviewers` string
- `reviewerNots` string
- `labels` string
- `labelNots` string
- `milestones` string
- `milestoneNots` string
- `sourceBranches` string
- `sourceBranchNots` string
- `targetBranches` string
- `targetBranchNots` string
- `crossForkValues` string
- `crossForkNots` string
- `lockedValues` string
- `lockedNots` string

## Response `200`

Response for status 200

- PullPage
  - `items` PullListItem[], required
    - `id` string, required
    - `number` integer, required
    - `title` string, required
    - `state` 'open' | 'closed' | 'merged', required
    - `draft` boolean, required
    - `createdAt` string, date-time, required
    - `author` union, required
      - object
        - `kind` 'local', required
        - `actorId` string, required
        - `handle` string, required
        - `displayName` string, nullable, required
        - `avatarUrl` string, nullable, required
        - `bot` true
        - `app` object
          - `listed` boolean, required
        - `via` object
          - `app` string, required
          - `iconUrl` string, nullable, required
      - object
        - `kind` 'github', required
        - `actorId` string, required
        - `authority` 'https://github.com', required
        - `providerId` integer, required
        - `login` string, required
        - `accountType` 'user' | 'organization' | 'bot', required
        - `avatarUrl` string, nullable, required
        - `linkedProfile` object, nullable
          - `actorId` string
          - `handle` string, required
          - `displayName` string, nullable, required
          - `avatarUrl` string, nullable, required
      - object
        - `kind` 'unavailable', required
        - `actorId` string, required
    - `sourceBranch` string, required
    - `targetBranch` string, required
    - `headOid` string, nullable, required
    - `authorActorId` string, required
    - `updatedAt` string, date-time, required
    - `version` integer, required
    - `additions` integer, nullable, required
    - `deletions` integer, nullable, required
    - `changedFiles` integer, nullable, required
    - `mergedAt` string, date-time, nullable, required
    - `labels` object[], required
      - `id` string, required
      - `name` string, required
      - `color` string, required
    - `assignees` AssignmentActor[], required
      - `id` string, required
      - `actor` union, required
        - object
          - `kind` 'local', required
          - `actorId` string, required
          - `handle` string, required
          - `displayName` string, nullable, required
          - `avatarUrl` string, nullable, required
          - `bot` true
          - `app` object
            - `listed` boolean, required
          - `via` object
            - `app` string, required
            - `iconUrl` string, nullable, required
        - object
          - `kind` 'github', required
          - `actorId` string, required
          - `authority` 'https://github.com', required
          - `providerId` integer, required
          - `login` string, required
          - `accountType` 'user' | 'organization' | 'bot', required
          - `avatarUrl` string, nullable, required
          - `linkedProfile` object, nullable
            - `actorId` string
            - `handle` string, required
            - `displayName` string, nullable, required
            - `avatarUrl` string, nullable, required
        - object
          - `kind` 'unavailable', required
          - `actorId` string, required
      - `handle` string, nullable, required
      - `displayName` string, nullable, required
      - `avatarUrl` string, nullable, required
    - `reviewers` AssignmentActor[], required
      - `id` string, required
      - `actor` union, required
        - object
          - `kind` 'local', required
          - `actorId` string, required
          - `handle` string, required
          - `displayName` string, nullable, required
          - `avatarUrl` string, nullable, required
          - `bot` true
          - `app` object
            - `listed` boolean, required
          - `via` object
            - `app` string, required
            - `iconUrl` string, nullable, required
        - object
          - `kind` 'github', required
          - `actorId` string, required
          - `authority` 'https://github.com', required
          - `providerId` integer, required
          - `login` string, required
          - `accountType` 'user' | 'organization' | 'bot', required
          - `avatarUrl` string, nullable, required
          - `linkedProfile` object, nullable
            - `actorId` string
            - `handle` string, required
            - `displayName` string, nullable, required
            - `avatarUrl` string, nullable, required
        - object
          - `kind` 'unavailable', required
          - `actorId` string, required
      - `handle` string, nullable, required
      - `displayName` string, nullable, required
      - `avatarUrl` string, nullable, required
    - `reviewVerdicts` object, nullable, required
      - `items` object[], required
        - `reviewer` union, required
          - object
            - `kind` 'local', required
            - `actorId` string, required
            - `handle` string, required
            - `displayName` string, nullable, required
            - `avatarUrl` string, nullable, required
            - `bot` true
            - `app` object
              - …
            - `via` object
              - …
          - object
            - `kind` 'github', required
            - `actorId` string, required
            - `authority` 'https://github.com', required
            - `providerId` integer, required
            - `login` string, required
            - `accountType` 'user' | 'organization' | 'bot', required
            - `avatarUrl` string, nullable, required
            - `linkedProfile` object, nullable
              - …
          - object
            - `kind` 'unavailable', required
            - `actorId` string, required
        - `verdict` 'approve' | 'request_changes' | 'dismissed', required
        - `commitOid` string, required
      - `truncated` boolean, required
    - `milestone` object, nullable, required
      - `id` string, required
      - `number` integer, required
      - `title` string, required
      - `state` 'open' | 'closed', required
    - `stack` object, nullable, required
      - `number` integer, required
      - `position` integer, required
      - `size` integer, required
    - `providerConflictCheck` object, nullable, required
      - `authority` string, required
      - `githubNumber` integer, required
      - `baseBranch` string, required
      - `state` 'pending' | 'mergeable' | 'conflicting' | 'null', nullable, required
      - `headOid` string, nullable, required
      - `baseOid` string, nullable, required
      - `observedAt` string, date-time, nullable, required
      - `convergedBaseOid` string, nullable, required
  - `next` string, nullable, required

## Other responses

- `400`: The request is invalid.
- `401`: Authentication is required, or the supplied credential is invalid.
- `403`: The credential does not permit this operation. A `code`, when present, names the refusal.
- `404`: The resource does not exist or is not visible to the caller.
- `409`: The request conflicts with the current state. A `code`, when present, names the refusal; `retryable` says whether the same request can succeed later, and `operationId` names the operation in the way.
- `429`: A rate limit is exhausted. Wait Retry-After seconds; the value is a hint, so back off on a repeat 429.
- `503`: A required service is temporarily unavailable; retry later.

---

[API](https://skmtc.dev/gitcafe/apis/git-cafe-api.md) - [All operations](https://skmtc.dev/gitcafe/apis/git-cafe-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gitcafe/apis/git-cafe-api/revisions/9fa233d2986d?raw)