In GraphQL API for BranchProtection Object fields are missing compared to UI settings - so not able to collect data

[ns-manojs]

Select Topic Area

Question

Body

Hi Team,

I am Using GraphQL API to collect data related to Branch Protection for the fields mentioned - here
This documentation has missing fields related to MergeQueue and Restrict pushes that create matching branches so not sure what to mention in the GraphQL query to collect this data.
MergeQueue

Restrict pushes that create matching branches

[Cre4T3Tiv3]

Hi @ns-manojs

I looked into your question about Branch Protection and the missing mergeQueue and restrict pushes fields in GraphQL and thought I would share what I found. Hopefully this helps point you in the right direction.

---

Why mergeQueue is missing in BranchProtectionRule

The GraphQL BranchProtectionRule object does not include a mergeQueue field. Merge Queue is not exposed in that part of the schema. The only accessible mergeQueue field in GraphQL exists at the repository level, where you can query current entries, their state, position, and related data. There is no GraphQL schema field that lets you check if Merge Queue is enabled for a specific branch protection rule. (GitHub Docs, GitHub Schema)

---

What is available: restrictsPushes

You can query whether a branch protection rule is set to restrict pushes. The BranchProtectionRule type includes the Boolean field restrictsPushes, which corresponds directly to the “Restrict pushes that create matching branches” setting in the GitHub UI. For example:

repository(owner: "...", name: "...") {
  branchProtectionRules(first: 10) {
    nodes {
      pattern
      restrictsPushes
    }
  }
}

This field is supported in the schema. (GitHub Discussion, Gist)

---

How to work with Merge Queue in GraphQL today

To interact with Merge Queue in GraphQL, you need to query the repository-level mergeQueue field—not within branch protection rules:

repository(owner: "...", name: "...") {
  mergeQueue {
    entries {
      pullRequest {
        number
        title
      }
      position
      state
    }
  }
}

This gives you details about the queue itself, such as pending PRs and their statuses. It does not indicate which branch protection rules have Merge Queue enabled. (GitHub Schema)

---

Summary

Setting	GraphQL Support	Access Method
Restrict pushes (branch level)	Yes (restrictsPushes)	Use BranchProtectionRule.restrictsPushes
Merge Queue configuration (branch)	Not available	No schema field in BranchProtectionRule
Merge Queue status (repository)	Yes (mergeQueue)	Query repository-level mergeQueue

At this time, neither GraphQL nor REST APIs expose whether Merge Queue is enabled for a branch protection rule. The only API access available is the repository-level queue, which shows entries but not the rule-level enablement setting.

---

If reading the enablement setting is critical for your automation, you may consider filing a feature request so that Merge Queue configuration is exposed in the schema.

---

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬