API Reference
Complete reference for the Mergify REST API
https://api.mergify.com/v1
All endpoints require a Bearer token. Two kinds of Mergify credentials are supported:
- Application Key — generated from your Mergify dashboard
-
User Token — issued by
mergify auth login
See API Usage for setup instructions.
Applications
1 endpointManage your Mergify application details.
Queues
7 endpointsConfigure and inspect merge queues for your repositories.
Simulator
3 endpointsSimulate Mergify behavior on pull requests and configurations.
Activity Log
2 endpointsRetrieve and aggregate the timeline of Mergify events for a repository.
Statistics
20 endpointsAccess merge queue and CI performance statistics.
Pull Requests
3 endpointsPush scopes and other per-pull-request data to Mergify.
Test Engine
20 endpointsAccess data from Test Engine.
CI Insights
3 endpointsAccess data from CI Insights.
Scheduled Freeze
5 endpointsSchedule merge queue freezes for maintenance or release windows.
Merge Queue
21 endpointsControl merge queue state — pause, unpause, and inspect status.
Products
3 endpointsProducts endpoints for the Mergify API.
Integrations
6 endpointsIntegrations endpoints for the Mergify API.
Was this page helpful?
Thanks for your feedback!