Version 2 is under construction
DEVELOPER REFERENCE

REST & GraphQL API Reference

Query review histories, codebase health metrics, and trigger audits programmatically.

GitRabbit exposes versioned REST and GraphQL endpoints for querying pull request review histories, updating organization rules, reading repository health scores, and triggering automated spec audits from external CI workflows. All API requests authenticate with a Bearer token in the Authorization header.

Key Capabilities

API Authentication

Access the API securely using personal developer tokens or organization tokens.

Rate Limiting & Safety

Generous rate limits of 10,000 requests/hour per organization with secure CORS rules.

Webhooks Integration

Listen for real-time review completions, security notifications, or team changes.

Setup & Workflow

1
Step 01

Generate API Token

Go to the Settings page in the GitRabbit web console and generate a new Developer Token.

2
Step 02

Authorize Request

Include the API token as a Bearer token in the 'Authorization' header of your HTTP request.

3
Step 03

Query Endpoint

Make a request to any of our API endpoints (e.g. '/v1/reviews').

$curl -H "Authorization: Bearer gr_dev_token" https://api.gitrabbit.com/v1/reviews

Configuration & Reference

REST API Endpoint: GET /v1/reviews/health-score
// Request
GET https://api.gitrabbit.com/v1/reviews/health-score?repo=frontend-app
Headers:
  Authorization: Bearer gr_dev_token_xyz

// Response
{
  "status": "success",
  "data": {
    "repository": "frontend-app",
    "score": "A-",
    "issues_count": {
      "critical": 0,
      "high": 2,
      "medium": 15,
      "low": 42
    },
    "scanned_at": "2026-08-04T10:00:00Z"
  }
}

Best Practices

  • Keep your API tokens safe and rotate them regularly in settings.
  • Check our OpenAPI specification (swagger.json) in the dashboard for the complete endpoint schema definitions.
Was this page helpful?