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_*, orgho_*)
See API Usage for setup instructions.
Applications
1 endpointManage your Mergify application details.
GET
Queues
7 endpointsConfigure and inspect merge queues for your repositories.
GET
PUT
DELETE
POST
Badges
3 endpointsGenerate status badges for your repositories.
GET
Simulator
3 endpointsSimulate Mergify behavior on pull requests and configurations.
POST
Event Logs
1 endpointRetrieve event logs for pull request activity.
GET
Statistics
14 endpointsAccess merge queue and CI performance statistics.
GET
Scheduled Freeze
5 endpointsSchedule merge queue freezes for maintenance or release windows.
GET
POST
PATCH
DELETE
Merge Queue
4 endpointsControl merge queue state — pause, unpause, and inspect status.
GET
PUT
DELETE
Was this page helpful?
Thanks for your feedback!