Bitbucket REST API - getting branches

tomer bar

Hi all,

Using the REST API we are trying to retrieve data about branches in the workspace. 

Using https://api.bitbucket.org/2.0/repositories/{workspace}/(repository}/refs/branches we get a response exampled in the link. It has values holding the various branches but does not hold any of the wanted data - author, created date etc. 

Unless it is the data specified under 'target' .. Is that the case (target references the requested branch), or are we using it wrong?

response example  

Thanks!

Ben

G'day Tomer!

Welcome to the Bitbucket Cloud community!  

To retrieve information about certain ref types (ie branches/tags), you would need to modify the URL slightly by adding "/branches" or "/tags" after "ref", for example:

https://api.bitbucket.org/2.0/repositories/{workspace}/(repository}/refs/branches
https://api.bitbucket.org/2.0/repositories/{workspace}/(repository}/refs/tags

To filter this information further (for example - looking for a certain branch) the format is:

name ~ "insertnamehere"

Formatting this to unicode, you can include this in the url with the ?q parameter to view information about a certain branch:

https://api.bitbucket.org/2.0/repositories/{workspace}/(repository}/refs/branches?q=name~"{branchname}"

Further information regarding querying/sorting can be found here:
https://developer.atlassian.com/cloud/bitbucket/rest/intro/#filtering

Hope this helps.

Cheers!

- Ben (Bitbucket Cloud Support)