> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Read the existing CodeRabbit review status for a pull request

> Reads the existing Triage observation after checking current repository and pull-request access. Null means no usable observation is available, not proof that no review ran. The observed target commit can differ from the current provider head. Unconfirmed means progress has not been confirmed recently, not that execution stopped. This does not create or track a new review execution.



## OpenAPI

````yaml /openapi.json get /v1/repositories/{repository_id}/pull-requests/{pull_request_number}/review
openapi: 3.0.3
info:
  title: CodeRabbit API spec
  version: 1.0.0
servers:
  - url: https://api.coderabbit.ai
security:
  - ApiKeyAuth: []
paths:
  /v1/repositories/{repository_id}/pull-requests/{pull_request_number}/review:
    get:
      tags:
        - Reviews
      summary: Read the existing CodeRabbit review status for a pull request
      description: >-
        Reads the existing Triage observation after checking current repository
        and pull-request access. Null means no usable observation is available,
        not proof that no review ran. The observed target commit can differ from
        the current provider head. Unconfirmed means progress has not been
        confirmed recently, not that execution stopped. This does not create or
        track a new review execution.
      operationId: get_pull_request_review
      parameters:
        - name: repository_id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[1-9]\d*$
        - name: pull_request_number
          in: path
          required: true
          schema:
            type: integer
            minimum: 0
            maximum: 2147483647
            exclusiveMinimum: true
        - name: org_id
          in: query
          schema:
            type: string
            minLength: 1
            description: >-
              Git-provider organization ID. Required for workspace keys; omit
              for organization keys. This differs from the CodeRabbit
              organization ID in scope.id.
          allowEmptyValue: true
          allowReserved: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformPullRequestReview'
        '400':
          description: '400'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - invalid_request
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '401':
          description: '401'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - unauthenticated
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '403':
          description: '403'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - forbidden
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '404':
          description: '404'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - not_found
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '409':
          description: '409'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - head_changed
                          - conflict
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '412':
          description: '412'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - precondition_failed
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '413':
          description: '413'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - payload_too_large
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '429':
          description: '429'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - rate_limit_exceeded
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '500':
          description: '500'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - internal_error
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '503':
          description: '503'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - unavailable
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
components:
  schemas:
    PlatformPullRequestReview:
      type: object
      properties:
        head_sha:
          type: string
          description: Current pull-request head reported by GitHub.
        review:
          anyOf:
            - type: object
              properties:
                status:
                  enum:
                    - pending
                    - starting
                    - reviewing
                    - failed
                    - completed
                    - unconfirmed
                  type: string
                  description: >-
                    Existing review state. Unconfirmed means progress has not
                    been confirmed recently; it does not establish that
                    execution stopped.
                  example: reviewing
                reason:
                  anyOf:
                    - type: string
                    - type: string
                      nullable: true
                      enum:
                        - null
                  description: >-
                    Reason recorded by the existing review tracker, when
                    available.
                request_id:
                  anyOf:
                    - type: string
                    - type: string
                      nullable: true
                      enum:
                        - null
                  description: Existing review request identifier, when available.
                target_commit_sha:
                  anyOf:
                    - type: string
                    - type: string
                      nullable: true
                      enum:
                        - null
                  description: >-
                    Commit associated with the observation; it can differ from
                    head_sha or be unknown.
                requested_at:
                  anyOf:
                    - type: string
                      format: date-time
                    - type: string
                      nullable: true
                      enum:
                        - null
                  description: Original request time, when recorded.
                updated_at:
                  type: string
                  format: date-time
                  description: >-
                    Original observation timestamp, not the time this API
                    response was read.
              required:
                - status
                - reason
                - request_id
                - target_commit_sha
                - requested_at
                - updated_at
              additionalProperties: false
            - type: string
              nullable: true
              enum:
                - null
          description: >-
            Existing Triage review observation, or null when no usable
            observation is available. Compare target_commit_sha with head_sha;
            completion does not prove that the current head was reviewed or that
            results were published.
      required:
        - head_sha
        - review
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-coderabbitai-api-key
      description: >-
        API key for authentication. You can create an API key from the
        CodeRabbit dashboard.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.