---
title: "List branch restrictions"
method: GET
path: "/repositories/{workspace}/{repo_slug}/branch-restrictions"
tags: ["Branch restrictions"]
---

# List branch restrictions

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

Returns a paginated list of all branch restrictions on the
repository.

## Query parameters

- `kind` string
- `pattern` string

## Response `200`

A paginated list of branch restrictions

- PaginatedBranchrestrictions — A paginated list of branch restriction rules.
  - `size` integer — Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.
  - `page` integer — Page number of the current results. This is an optional element that is not provided in all responses.
  - `pagelen` integer — Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.
  - `next` string, uri — Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.
  - `previous` string, uri — Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.
  - `values` Branchrestriction[]
    - `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`.
    - `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_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 does not exist

---

[API](https://skmtc.net/bitbucket/apis/bitbucket-api.md) · [All operations](https://skmtc.net/bitbucket/apis/bitbucket-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bitbucket/bitbucket-api/revisions/7e9be973015d/schema)