Refs

Get a branch

Returns a branch object within the specified repository.

This call requires authentication. Private repositories require the caller to authenticate with an account that has appropriate authorization.

For Git, the branch name should not include any prefixes (e.g. refs/heads).

get/repositories/{workspace}/{repo_slug}/refs/branches/{name}

Request

  • Base URL
    https://api.bitbucket.org/2.0
  • Auth
    • OAuth 2
      Authorization code: https://bitbucket.org/site/oauth2/authorize
      Token URL: https://bitbucket.org/site/oauth2/access_token scopes: repository
    • or HTTP basic
    • or API key in header Authorization

Response

The branch object.

typestring required
namestring

The name of the ref.

merge_strategiesstring[]

Available merge strategies for pull requests targeting this branch.

default_merge_strategystring

The default merge strategy for pull requests targeting this branch.

Changes

No recorded changes to this operation across all 23 revisions of this API.