Read an existing report configuration
curl --request GET \
--url https://api.coderabbit.ai/v1/reports/{report_id} \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/reports/{report_id}"
headers = {"x-coderabbitai-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};
fetch('https://api.coderabbit.ai/v1/reports/{report_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"report_id": "<string>",
"name": "<string>",
"time": "<string>",
"timezone": "<string>",
"type": "<string>",
"disabled": true,
"frequency": 123,
"days": [
123
],
"parameters": [
{
"parameter": "<string>",
"operator": "<string>",
"values": [
"<string>"
]
}
],
"group": "<string>",
"subgroup": "<string>",
"prompt_template": "<string>",
"prompt": "<string>",
"platforms": [
{
"platform": "<string>",
"channel": "<string>"
}
],
"emails": [
"<string>"
],
"from": "<string>",
"to": "<string>"
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 1
}
}Read an existing report configuration
Returns saved configuration, not generated report content or execution status. disabled is the native schedule setting. A Teams webhook destination is returned as channel “[REDACTED]”.
GET
/
v1
/
reports
/
{report_id}
Read an existing report configuration
curl --request GET \
--url https://api.coderabbit.ai/v1/reports/{report_id} \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/reports/{report_id}"
headers = {"x-coderabbitai-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};
fetch('https://api.coderabbit.ai/v1/reports/{report_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"report_id": "<string>",
"name": "<string>",
"time": "<string>",
"timezone": "<string>",
"type": "<string>",
"disabled": true,
"frequency": 123,
"days": [
123
],
"parameters": [
{
"parameter": "<string>",
"operator": "<string>",
"values": [
"<string>"
]
}
],
"group": "<string>",
"subgroup": "<string>",
"prompt_template": "<string>",
"prompt": "<string>",
"platforms": [
{
"platform": "<string>",
"channel": "<string>"
}
],
"emails": [
"<string>"
],
"from": "<string>",
"to": "<string>"
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 1
}
}- CLI Tool
- MCP Server
coderabbit api request "/reports/$REPORT_ID"
An agent connected to the CodeRabbit MCP server runs this operation as the
get_report tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "get_report",
"arguments": {
"report_id": 1
}
}
}
Authorizations
See Authentication for the key types and where to create a key.
Query Parameters
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:
1Response
OK
Was this page helpful?