Skip to main content
GET
Read an accessible pull request and its current checks
Use the repository’s Git provider ID and the PR’s local number. Review and merge fields are observations; they do not establish canonical CodeRabbit review completion. See how to interpret the response and continue threads.

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

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

Required range: 0 < x <= 2147483647

Query Parameters

org_id
string

Git-provider organization ID. Required for workspace keys; omit for organization keys.

Minimum string length: 1
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_page_size
integer
Required range: 1 <= x <= 100
thread_page_token
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