Skip to main content
GET
Read the existing CodeRabbit review status for a pull request
To install and sign in to the CLI, see Call from the CLI.

Authorizations

x-coderabbitai-api-key
string
header
required

See Authentication for the key types and where to create a key.

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

Organization for a workspace key: the Git-provider organization ID (scope.provider_organization_id) or the CodeRabbit organization ID (scope.id, or id from list organizations). Supply either org_id or org_name, never both. Omit for organization keys and MCP connections.

Minimum string length: 1
org_name
string

GitHub organization login, such as coderabbitai, not its display name. Matched case-insensitively within the authenticated workspace. Supply either org_name or org_id, never both; omit for organization keys and MCP connections.

Pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,38}$

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.