---
title: "Read pull request status"
method: GET
path: "/api/repos/{owner}/{repo}/pulls/{pr}/status"
tags: ["Pull Requests"]
---

# Read pull request status

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

## Request

- Base URL: `https://git.cafe`
- URL: `https://git.cafe/api/repos/{owner}/{repo}/pulls/{pr}/status`
- 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`

Read pull request status. Public repositories allow anonymous reads; supplied credentials are validated and may expand access to private resources.

## Path parameters

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

## Response `200`

Response for status 200

- object
  - `id` string, required
  - `version` integer, required
  - `headOid` string, nullable, required
  - `baseOid` string, nullable, required
  - `observation` 'stored', required
  - `merge` object, required
    - `state` 'blocked' | 'requires-native-check', required
    - `strategies` string[], required
    - `permitted` boolean, required
    - `reasons` string[], required
    - `warnings` string[], required
    - `fastForward` boolean, nullable, required
    - `conflicts` 'unknown' | 'pending' | 'none' | 'conflicting', required
    - `conflictCheck` object
      - `state` 'pending' | 'mergeable' | 'conflicting', required
      - `headOid` string, required
      - `baseOid` string, required
      - `observedAt` string, date-time, required
      - `current` boolean, required
    - `blockers` object[], required
      - `code` string, required
      - `message` string, required
      - `blockedStrategies` string[]
      - `operationId` union
        - string
        - string
    - `verdict` object, required
      - `kind` 'mergeable' | 'waiting' | 'blocked' | 'merged' | 'closed', required
      - `checks` string[]
      - `reasons` object[]
        - `code` string, required
        - `message` string, required
        - `blockedStrategies` string[]
        - `operationId` union
          - string
          - string
      - `next` string, required
    - `rulesets` object, required
      - `matched` integer, required
      - `violations` object[], required
        - `rulesetId` string, required
        - `rulesetName` string, required
        - `enforcement` 'active' | 'evaluate', required
        - `rule` 'require_pull_request' | 'require_status_checks' | 'restrict_pushes' | 'require_linear_history' | 'require_merge_strategy' | 'require_signatures' | 'require_deployments' | 'restrict_file_paths' | 'invalid_configuration', required
        - `message` string, required
        - `blockedStrategies` string[]
      - `warnings` object[], required
        - `rulesetId` string, required
        - `rulesetName` string, required
        - `enforcement` 'active' | 'evaluate', required
        - `rule` 'require_pull_request' | 'require_status_checks' | 'restrict_pushes' | 'require_linear_history' | 'require_merge_strategy' | 'require_signatures' | 'require_deployments' | 'restrict_file_paths' | 'invalid_configuration', required
        - `message` string, required
        - `blockedStrategies` string[]
  - `checks` object, required
    - `pending` integer, required
    - `failing` integer, required
    - `successful` integer, required
    - `total` integer, required
    - `contexts` object[], required
      - `context` string, required
      - `state` 'pending' | 'success' | 'failure', required
      - `required` boolean, required
      - `appId` string
      - `ciRunId` string
      - `url` string

## 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)