--- title: "Get a branch" method: GET path: "/repositories/{workspace}/{repo_slug}/refs/branches/{name}" tags: ["Refs"] --- # Get a branch `GET /repositories/{workspace}/{repo_slug}/refs/branches/{name}` 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). ## Response `200` The branch object. - Branch — A branch object, representing a branch in a repository. - `type` string, required - `links` object - `self` object — A link to a resource related to this object. - `href` string, uri - `name` string - `commits` 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 - `name` string — The name of the ref. - `target` Commit — A repository commit object. - `type` string, required - `hash` string - `date` string, date-time - `author` Author — The author of a change in a repository - `type` string, required - `raw` string — The raw author value from the repository. This may be the only value available if the author does not match a user in Bitbucket. - `user` 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 - `committer` Committer — The committer of a change in a repository - `type` string, required - `raw` string — The raw committer value from the repository. This may be the only value available if the committer does not match a user in Bitbucket. - `user` 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 - `message` string - `summary` object - `raw` string — The text as it was typed by a user. - `markup` 'markdown' | 'creole' | 'plaintext' — The type of markup language the raw content is to be interpreted in. - `html` string — The user's content rendered as HTML. - `parents` BaseCommit[] - `type` string, required - `hash` string - `date` string, date-time - `author` Author — The author of a change in a repository - `type` string, required - `raw` string — The raw author value from the repository. This may be the only value available if the author does not match a user in Bitbucket. - `user` 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. - … - `created_on` string, date-time - `display_name` string - `uuid` string - `committer` Committer — The committer of a change in a repository - `type` string, required - `raw` string — The raw committer value from the repository. This may be the only value available if the committer does not match a user in Bitbucket. - `user` 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. - … - `created_on` string, date-time - `display_name` string - `uuid` string - `message` string - `summary` object - `raw` string — The text as it was typed by a user. - `markup` 'markdown' | 'creole' | 'plaintext' — The type of markup language the raw content is to be interpreted in. - `html` string — The user's content rendered as HTML. - `parents` BaseCommit[] - `repository` Repository — A Bitbucket repository. - `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 - `avatar` object — A link to a resource related to this object. - `href` string, uri - `name` string - `pullrequests` object — A link to a resource related to this object. - `href` string, uri - `name` string - `commits` object — A link to a resource related to this object. - `href` string, uri - `name` string - `forks` object — A link to a resource related to this object. - `href` string, uri - `name` string - `watchers` object — A link to a resource related to this object. - `href` string, uri - `name` string - `downloads` object — A link to a resource related to this object. - `href` string, uri - `name` string - `clone` object[] - `href` string, uri - `name` string - `hooks` object — A link to a resource related to this object. - `href` string, uri - `name` string - `uuid` string — The repository's immutable id. This can be used as a substitute for the slug segment in URLs. Doing this guarantees your URLs will survive renaming of the repository by its owner, or even transfer of the repository to a different user. - `full_name` string — The concatenation of the repository owner's username and the slugified name, e.g. "evzijst/interruptingcow". This is the same string used in Bitbucket URLs. - `is_private` boolean - `parent` Repository — recursive - `scm` 'git' - `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 - `name` string - `description` string - `created_on` string, date-time - `updated_on` string, date-time - `size` integer - `language` string - `has_issues` boolean — The issue tracker for this repository is enabled. Issue Tracker features are not supported for repositories in workspaces administered through admin.atlassian.com. - `has_wiki` boolean — The wiki for this repository is enabled. Wiki features are not supported for repositories in workspaces administered through admin.atlassian.com. - `fork_policy` 'allow_forks' | 'no_public_forks' | 'no_forks' — Controls the rules for forking this repository. * **allow_forks**: unrestricted forking * **no_public_forks**: restrict forking to private forks (forks cannot be made public later) * **no_forks**: deny all forking - `project` Project — A Bitbucket project. Projects are used by teams to organize repositories. - `type` string, required - `links` object - `html` object — A link to a resource related to this object. - `href` string, uri - `name` string - `avatar` object — A link to a resource related to this object. - `href` string, uri - `name` string - `uuid` string — The project's immutable id. - `key` string — The project's key. - `owner` Team — A team object. - `type` string, required - `links` object — Links related to a Team. - `avatar` Link — A link to a resource related to this object. - … - `self` Link — A link to a resource related to this object. - … - `html` Link — A link to a resource related to this object. - … - `members` Link — A link to a resource related to this object. - … - `projects` Link — A link to a resource related to this object. - … - `repositories` Link — A link to a resource related to this object. - … - `created_on` string, date-time - `display_name` string - `uuid` string - `name` string — The name of the project. - `description` string - `is_private` boolean — Indicates whether the project is publicly accessible, or whether it is private to the team and consequently only visible to team members. Note that private projects cannot contain public repositories. - `created_on` string, date-time - `updated_on` string, date-time - `has_publicly_visible_repos` boolean — Indicates whether the project contains publicly visible repositories. Note that private projects cannot contain public repositories. - `mainbranch` Branch — recursive - `participants` Participant[] - `type` string, required - `user` 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 - `role` 'PARTICIPANT' | 'REVIEWER' - `approved` boolean - `state` string - `participated_on` string, date-time — The ISO8601 timestamp of the participant's action. For approvers, this is the time of their approval. For commenters and pull request reviewers who are not approvers, this is the time they last commented, or null if they have not commented. - `merge_strategies` string[] — Available merge strategies for pull requests targeting this branch. - `default_merge_strategy` string — The default merge strategy for pull requests targeting this branch. ## Other responses - `403` — If the repository is private and the authenticated user does not have access to it. - `404` — The specified repository or branch 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/d98b7da55533/schema)