---
title: "Get a branch restriction rule"
method: GET
path: "/repositories/{workspace}/{repo_slug}/branch-restrictions/{id}"
tags: ["Branch restrictions"]
---

# Get a branch restriction rule

`GET /repositories/{workspace}/{repo_slug}/branch-restrictions/{id}`

## Request

- Base URL: `https://api.bitbucket.org/2.0`
- URL: `https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/branch-restrictions/{id}`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://bitbucket.org/site/oauth2/authorize`
    - Token URL: `https://bitbucket.org/site/oauth2/access_token` scopes: `repository:admin`
  - HTTP basic
  - API key in header `Authorization`

Returns a specific branch restriction rule.

## Response `200`

The branch restriction rule

- Branchrestriction: A branch restriction rule.
  - `type` string, required
  - `links` object
    - `self` object: A link to a resource related to this object.
      - `href` string, uri
      - `name` string
  - `id` integer: The branch restriction status' id.
  - `kind` 'push' | 'delete' | 'force' | 'restrict_merges' | 'require_tasks_to_be_completed' | 'require_approvals_to_merge' | 'require_review_group_approvals_to_merge' | 'require_default_reviewer_approvals_to_merge' | 'require_no_changes_requested' | 'require_passing_builds_to_merge' | 'require_commits_behind' | 'reset_pullrequest_approvals_on_change' | 'smart_reset_pullrequest_approvals' | 'reset_pullrequest_changes_requested_on_change' | 'require_all_dependencies_merged' | 'enforce_merge_checks' | 'allow_auto_merge_when_builds_pass' | 'require_all_comments_resolved', required: The type of restriction that is being applied.
  - `branch_match_kind` 'branching_model' | 'glob', required: Indicates how the restriction is matched against a branch. The default is `glob`.
  - `branch_type` 'feature' | 'bugfix' | 'release' | 'hotfix' | 'development' | 'production': Apply the restriction to branches of this type. Active when `branch_match_kind` is `branching_model`. The branch type will be calculated using the branching model configured for the repository.
  - `pattern` string, required: Apply the restriction to branches that match this pattern. Active when `branch_match_kind` is `glob`. Will be empty when `branch_match_kind` is `branching_model`.
  - `pipelines_source_branches` string[]: List of source branch names allowed to push back to the restricted branch. Used in conjunction with pipeline-based restrictions.
  - `value` integer: Value with kind-specific semantics: * `require_approvals_to_merge` uses it to require a minimum number of approvals on a PR. * `require_default_reviewer_approvals_to_merge` uses it to require a minimum number of approvals from default reviewers on a PR. * `require_passing_builds_to_merge` uses it to require a minimum number of passing builds. * `require_commits_behind` uses it to require the current branch is up to a maximum number of commits behind it destination.
  - `users` Account[]
    - `type` string, required
    - `links` AccountLinks: Links related to an Account.
      - `avatar` Link: A link to a resource related to this object.
        - `href` string, uri
        - `name` string
    - `created_on` string, date-time
    - `display_name` string
    - `uuid` string
  - `groups` Group[]
    - `type` string, required
    - `links` object
      - `self` object: A link to a resource related to this object.
        - `href` string, uri
        - `name` string
      - `html` object: A link to a resource related to this object.
        - `href` string, uri
        - `name` string
    - `owner` Account: An account object.
      - `type` string, required
      - `links` AccountLinks: Links related to an Account.
        - `avatar` Link: A link to a resource related to this object.
          - `href` string, uri
          - `name` string
      - `created_on` string, date-time
      - `display_name` string
      - `uuid` string
    - `workspace` Workspace: A Bitbucket workspace. Workspaces are used to organize repositories.
      - `type` string, required
      - `links` object
        - `avatar` object: A link to a resource related to this object.
          - `href` string, uri
          - `name` string
        - `html` object: A link to a resource related to this object.
          - `href` string, uri
          - `name` string
        - `members` object: A link to a resource related to this object.
          - `href` string, uri
          - `name` string
        - `owners` object: A link to a resource related to this object.
          - `href` string, uri
          - `name` string
        - `projects` object: A link to a resource related to this object.
          - `href` string, uri
          - `name` string
        - `repositories` object: A link to a resource related to this object.
          - `href` string, uri
          - `name` string
        - `snippets` object: A link to a resource related to this object.
          - `href` string, uri
          - `name` string
        - `self` object: A link to a resource related to this object.
          - `href` string, uri
          - `name` string
      - `uuid` string: The workspace's immutable id.
      - `name` string: The name of the workspace.
      - `slug` string: The short label that identifies this workspace.
      - `is_private` boolean: Indicates whether the workspace is publicly accessible, or whether it is private to the members and consequently only visible to members.
      - `is_personal` boolean: Indicates whether the workspace belongs to an individual user.
      - `is_privacy_enforced` boolean: Indicates whether the workspace enforces private content, or whether it allows public content.
      - `forking_mode` 'allow_forks' | 'internal_only': Controls the rules for forking repositories within this workspace. * **allow_forks**: unrestricted forking * **internal_only**: prevents forking of private repositories outside the workspace or to public repositories
      - `created_on` string, date-time
      - `updated_on` string, date-time
    - `name` string
    - `slug` string: The "sluggified" version of the group's name. This contains only ASCII characters and can therefore be slightly different than the name
    - `full_slug` string: The concatenation of the workspace's slug and the group's slug, separated with a colon (e.g. `acme:developers`)

## Other responses

- `401`: If the request was not authenticated
- `403`: If the authenticated user does not have admin access to the repository
- `404`: If the repository or branch restriction id does not exist

## Changes

- **2026-08-30** `5748cb124a33`: 1 info
  - added the optional property `allOf[subschema #2: Branch Restriction]/pipelines_source_branches` to the response with the `200` status
- **2026-08-08** `8c7911c0a910`: 1 info
  - added the optional property `allOf[subschema #2: Branch Restriction]/groups/items/allOf[subschema #2: Group]/workspace/allOf[subschema #2: Workspace]/is_personal` to the response with the `200` status
- **2026-07-13** `d344164ecb11`: 2 warning, 9 info
  - removed the optional property `allOf[subschema #2: Branch Restriction]/groups/items/allOf[subschema #2: Group]/owner/allOf[subschema #2: Account]/username` from the response with the `200` status
  - removed the optional property `allOf[subschema #2: Branch Restriction]/users/items/allOf[subschema #2: Account]/username` from the response with the `200` status
  - added the optional property `allOf[subschema #2: Branch Restriction]/branch_type` to the response with the `200` status
  - added the optional property `allOf[subschema #2: Branch Restriction]/groups/items/allOf[subschema #2: Group]/workspace/allOf[subschema #2: Workspace]/forking_mode` to the response with the `200` status
  - …7 more

[Operation history](https://skmtc.dev/atlassian/apis/bitbucket-api/changes/repositories/:workspace/:repo_slug/branch-restrictions/:id/get.md)

---

[API](https://skmtc.dev/atlassian/apis/bitbucket-api.md) - [All operations](https://skmtc.dev/atlassian/apis/bitbucket-api/llms.txt) - [OpenAPI document](https://skmtc.dev/atlassian/apis/bitbucket-api/revisions/6ae783fa75da?raw)