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

# Read pull request diff file

`GET /api/repos/{owner}/{repo}/pulls/{pr}/diff-file`

## Request

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

## Query parameters

- `path` string, required
- `expectedVersion` integer, required
- `contentOnly` 'true' | 'false'

## Response `200`

Response for status 200

- object
  - `id` string, required
  - `version` integer, required
  - `headOid` string, required
  - `baseOid` string, required
  - `comparisonBaseOid` string, required
  - `file` object, required
    - `path` string, required
    - `oldPath` string, nullable
    - `status` 'added' | 'deleted' | 'modified' | 'typeChanged' | 'conflicted' | 'renamed' | 'copied'
    - `additions` integer
    - `deletions` integer
    - `binary` boolean
    - `tooLarge` boolean
    - `hunksOmitted` boolean
    - `oldContent` string, nullable
    - `newContent` string, nullable
    - `oldContentUnavailableReason` 'binary' | 'too_large' | 'budget_exhausted' | 'non_blob'
    - `newContentUnavailableReason` 'binary' | 'too_large' | 'budget_exhausted' | 'non_blob'
    - `hunks` object[]
      - `oldStart` integer, required
      - `oldLines` integer, required
      - `newStart` integer, required
      - `newLines` integer, required
      - `lines` object[], required
        - `origin` ' ' | '+' | '-', required
        - `content` string, required

## Other responses

- `304`: Response for status 304
- `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`: Response for status 404
- `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`: Response for status 503

---

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