Skip to main content
GET
Read an existing report configuration
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

report_id
integer
required
Required range: x > 0

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

report_id
string
required
name
string
required
time
string
required
timezone
string
required
type
string
required
disabled
boolean
required
frequency
required
days
number[]
required
parameters
object[]
required
group
string
required
subgroup
string
required
prompt_template
required
prompt
required
platforms
object[]
required
emails
string[]
required
from
required
to
required