API Reference

Complete reference for the Mergify REST API

Base URL https://api.mergify.com/v1
Authentication

All endpoints require a Bearer token. Two authentication methods are supported:

  • Application Key — generated from your Mergify dashboard
  • GitHub Token — a GitHub personal access token (ghp_*, github_pat_*, or gho_*)

See API Usage for setup instructions.

Applications

1 endpoint

Manage your Mergify application details.

GET

Queues

7 endpoints

Configure and inspect merge queues for your repositories.

GET PUT DELETE POST

Badges

3 endpoints

Generate status badges for your repositories.

GET

Simulator

3 endpoints

Simulate Mergify behavior on pull requests and configurations.

POST

Event Logs

1 endpoint

Retrieve event logs for pull request activity.

GET

Statistics

14 endpoints

Access merge queue and CI performance statistics.

GET

Scheduled Freeze

5 endpoints

Schedule merge queue freezes for maintenance or release windows.

GET POST PATCH DELETE

Merge Queue

4 endpoints

Control merge queue state — pause, unpause, and inspect status.

GET PUT DELETE

Was this page helpful?