Skip to main content
GET
Read an accessible pull request and its current checks
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

Repository-local PR number, within the provider's GraphQL Int range.

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}$
expected_head_sha
string
Pattern: ^[a-f0-9]{40}$
include

Optional sections; defaults to checks. Use none for core metadata only, or repeat the query parameter to include both checks and threads.

Available options:
checks,
threads,
none
thread_author
string
Pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,38}(?:\[bot\])?$
thread_state
enum<string>
Available options:
unresolved,
resolved,
all
thread_limit
integer
Required range: 1 <= x <= 100
thread_cursor
string
Required string length: 1 - 4096
thread_include_outdated
boolean
thread_include_replies
boolean

Response

OK

pull_request
object
required
reviews
object
required
merge
object
required
blockers
object[]
required
coverage
object
required
head_sha
string
required
Pattern: ^[a-f0-9]{40}$
fetched_at
string
required
head_changed
boolean
required

Whether the observed head differs from expected_head_sha; not a review-completion signal.

expected_head_sha
string
Pattern: ^[a-f0-9]{40}$
checks
object
threads
object