ATatlassian
Snippets

List comments on a snippet

Changed on

Used to retrieve a paginated list of all comments for a specific snippet.

This resource works identical to commit and pull request comments.

The default sorting is oldest to newest and can be overridden with the sort query parameter.

get/snippets/{workspace}/{encoded_id}/comments

Request

  • Base URL
    https://api.bitbucket.org/2.0
  • URL
    https://api.bitbucket.org/2.0/snippets/{workspace}/{encoded_id}/comments
  • Auth
    • OAuth 2
      Authorization code: https://bitbucket.org/site/oauth2/authorize
      Token URL: https://bitbucket.org/site/oauth2/access_token scopes: snippet
    • or HTTP basic
    • or API key in header Authorization

Response

A paginated list of snippet comments, ordered by creation date.

sizeinteger

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.

pageinteger

Page number of the current results. This is an optional element that is not provided in all responses.

pageleninteger

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.

nextstring 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.

previousstring 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.

Changes

  • d344164ecb11Revision changes
    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status