Skip to main content
GET
Read the existing CodeRabbit review status for a pull request
Use the numeric repository id from repository listing, not GitHub’s node_id, and the PR’s local number. See how to interpret review state.

What’s next

Read pull requests

Interpret review observations and their target commits.

Find repositories

Find the numeric repository ID for your requests.

Authorizations

x-coderabbitai-api-key
string
header
required

API key for authentication. You can create an API key from the CodeRabbit dashboard.

Path Parameters

repository_id
string
required
Pattern: ^[1-9]\d*$
pull_request_number
integer
required
Required range: 0 < x <= 2147483647

Query Parameters

org_id
string

Git-provider organization ID. Required for workspace keys; omit for organization keys. This differs from the CodeRabbit organization ID in scope.id.

Minimum string length: 1

Response

OK

head_sha
string
required

Current pull-request head reported by GitHub.

review
required

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.