ATatlassian
Snippets

List snippets in a workspace

Changed on

Returns a paginated list of snippets owned by {workspace}.

To limit the set of returned snippets, apply the ?role=[owner|contributor|member] query parameter where the roles are defined as follows:

  • owner: snippets owned by {workspace} that also belong to the current user (only returns results when {workspace} is the current user's personal workspace)
  • contributor: snippets owned by {workspace} that the current user is watching, plus any owned by {workspace} and the current user
  • member: all snippets owned by {workspace} if the current user is a member, otherwise only those the current user is watching

When no role is specified, all snippets owned by {workspace} are returned.

If the current user is not a member of {workspace}, only public snippets are returned regardless of role.

The returned response is a normal paginated JSON list. This endpoint only supports application/json responses and no multipart/form-data or multipart/related. As a result, it is not possible to include the file contents.

get/snippets/{workspace}

Request

  • Base URL
    https://api.bitbucket.org/2.0
  • URL
    https://api.bitbucket.org/2.0/snippets/{workspace}
  • 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

Query parameters

role'owner' | 'contributor' | 'member'

Filter down the result based on the authenticated user's role (owner, contributor, or member).

Response

A paginated list of snippets.

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