Retrieving comments from Bitbucket server via REST API


I'm using Bitbucket server and I want to get the general comments of a pull request via the REST API. But somehow it does not work.

I've used https://bitbucket/rest/api/1.0/projects/MYPROJ/repos/myrepo/pull-requests but the response is a JSON object, with a lot of data, but the only reference to comments is: 

"properties": { "commentCount": 12,"openTaskCount": 0,"resolvedTaskCount": 0}, 

When I take a specifc pull request using: https://bitbucket/rest/api/1.0/projects/MYPROJ/repos/myrepo/pull-requests/2 then I will get another JSON object wit a lot of data, but no reference to any of the comments at all.

I only get the particulars of a comment using  https://bitbucket/rest/api/1.0/projects/MYPROJ/repos/myrepo/pull-requests/2/comments gives me an error: "The path query parameter is required when retrieving comments."

 Explicitly querying for comments with https://bitbucket/rest/api/1.0/projects/MYPROJ/repos/myrepo/pull-requests/2/comments/2916  does give me all the details of that specific comment, but I can only get the commentid by looking in the UI.

So can somebody explain how to get all general comments of a pull request?


2 answers

2 accepted

1 vote
Accepted answer

Hi Rudy, 

I believe the best way for you to get all the comments of a pull request is to use the activities endpoint.

You'll have to filter out anything that is not a comment, but it's going to be easier to do than grabbing comments individually for every file. 

As you discovered, the comments endpoint requires specifying a path as a query parameter, so only allows retrieving comments per file.

An example of this would be:


I hope this helps, 

Felix Haehnel
Graduate Developer
Bitbucket Server 

Thanks Felix, The activities endpoint will do it for me. It is way more data then I need, but better then nothing!

Can we do this without specifying path to the file

1 vote
Accepted answer

In more recent versions of Bitbucket, comments can also be retrieved by using the following REST API endpoint: 




More details area available on the Bitbucket REST resources page.

No, they can't!

Thats exactly the URL the Rudy used, and attaching all available parameters without a value will not solve anything, but results in the exact same error!

Suggest an answer

Log in or Sign up to answer
Community showcase
Published Nov 06, 2018 in Bitbucket

Upgrade Best Practices

Hello! My name is Mark Askew and I am a Premier Support Engineer for products Bitbucket Server/Data Center, Fisheye & Crucible. Today, I want to bring the discussion that Jennifer, Matt, and ...

678 views 5 9
Read article

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you