• App versions
  • Applications
  • Apps
  • Assets
  • Categories
  • License types
  • Migrations
  • Privacy and Security
  • Products
  • Promotions (Removed)
  • Reporting
  • Reviews
  • Vendors
Platform
Atlassian Marketplace / Reference / Marketplace REST API

Reviews

Postman Collection
OpenAPI
GET

Get app reviews

Get a list of reviews for the specified app.

Request

Path parameters

addonKey

string

Required

Query parameters

sort

string

offset

integer

limit

integer

hosting

string

Responses

application/json

ReviewCollection
GET/addons/{addonKey}/reviews
1 2 3 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "alternate": { "href": "<string>", "type": "<string>", "title": "<string>" }, "next": { "href": "<string>", "type": "<string>", "title": "<string>" }, "prev": { "href": "<string>", "type": "<string>", "title": "<string>" }, "byThisUser": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "_embedded": { "reviews": [ { "_links": { "self": { "href": "<string>" }, "alternate": { "href": "<string>" } }, "_embedded": {}, "review": "<string>", "stars": 15, "date": "<string>", "totalVotes": 21, "helpfulVotes": 23, "hosting": "cloud" } ] }, "count": 23, "averageStars": 23 }
POST

Create / update app review

Create or update a specific app review. This resource requires authentication.

Request

Path parameters

addonKey

string

Required

Request bodyapplication/json

_links

ReviewLinks

_embedded

ReviewEmbedded

review

string

stars

integer

Required

Responses

Successfully modified

Headers

Location

string

POST/addons/{addonKey}/reviews
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 curl --request POST \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json' \ --data '{ "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "alternate": { "href": "<string>", "type": "<string>", "title": "<string>" }, "author": {}, "response": { "href": "<string>", "type": "<string>", "title": "<string>" }, "flag": { "href": "<string>", "type": "<string>", "title": "<string>" }, "voteUp": { "href": "<string>", "type": "<string>", "title": "<string>" }, "voteDown": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "_embedded": { "author": { "_links": { "alternate": { "href": "<string>" }, "picture": { "href": "<string>" }, "pictureTemplate": { "template": "<string>" } }, "name": "<string>", "email": "<string>" }, "response": { "_links": { "self": { "href": "<string>" } }, "text": "<string>" } }, "review": "<string>", "stars": 15 }'
GET

Get app review

Get a specific app review.

Request

Path parameters

addonKey

string

Required
reviewId

string

Required

Responses

application/json

Review
GET/addons/{addonKey}/reviews/id/{reviewId}
1 2 3 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "alternate": { "href": "<string>", "type": "<string>", "title": "<string>" }, "author": {}, "response": { "href": "<string>", "type": "<string>", "title": "<string>" }, "flag": { "href": "<string>", "type": "<string>", "title": "<string>" }, "voteUp": { "href": "<string>", "type": "<string>", "title": "<string>" }, "voteDown": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "_embedded": { "author": { "_links": { "alternate": { "href": "<string>" }, "picture": { "href": "<string>" }, "pictureTemplate": { "template": "<string>" } }, "name": "<string>", "email": "<string>" }, "response": { "_links": { "self": { "href": "<string>" } }, "text": "<string>" } }, "review": "<string>", "stars": 15, "date": "<string>", "totalVotes": 21, "helpfulVotes": 23, "hosting": "cloud" }
PUT

Create / update app review

Create or update a specific app review.

Request

Path parameters

addonKey

string

Required
reviewId

string

Required

Request bodyapplication/json

_links

ReviewLinks

_embedded

ReviewEmbedded

review

string

stars

integer

Required

Responses

Successfully modified

Headers

Location

string

PUT/addons/{addonKey}/reviews/id/{reviewId}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 curl --request PUT \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}' \ --header 'Content-Type: application/json' \ --data '{ "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "alternate": { "href": "<string>", "type": "<string>", "title": "<string>" }, "author": {}, "response": { "href": "<string>", "type": "<string>", "title": "<string>" }, "flag": { "href": "<string>", "type": "<string>", "title": "<string>" }, "voteUp": { "href": "<string>", "type": "<string>", "title": "<string>" }, "voteDown": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "_embedded": { "author": { "_links": { "alternate": { "href": "<string>" }, "picture": { "href": "<string>" }, "pictureTemplate": { "template": "<string>" } }, "name": "<string>", "email": "<string>" }, "response": { "_links": { "self": { "href": "<string>" } }, "text": "<string>" } }, "review": "<string>", "stars": 15 }'
DEL

Delete app review

Delete a specific app review.

Request

Path parameters

addonKey

string

Required
reviewId

string

Required

Responses

Success

DEL/addons/{addonKey}/reviews/id/{reviewId}
1 2 curl --request DELETE \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}'
GET

Get app review downvote

Returns whether or not the current user has downvoted the specified app review. This resource requires authentication.

Request

Path parameters

addonKey

string

Required
reviewId

string

Required

Responses

application/json

BooleanState
GET/addons/{addonKey}/reviews/id/{reviewId}/down
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/down' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "up": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "state": true }
PUT

Update app review downvote

Updates whether or not the current user has downvoted the specified app review. This resource requires authentication.

Request

Path parameters

addonKey

string

Required
reviewId

string

Required

Request bodyapplication/json

_links

BooleanStateRepLinks

state

boolean

Required

Responses

Successfully modified

Headers

Location

string

PUT/addons/{addonKey}/reviews/id/{reviewId}/down
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 curl --request PUT \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/down' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json' \ --data '{ "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "up": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "state": true }'
GET

Get app review flag

Returns whether or not the current user has flagged the specified app review. This resource requires authentication.

Request

Path parameters

addonKey

string

Required
reviewId

string

Required

Responses

application/json

BooleanState
GET/addons/{addonKey}/reviews/id/{reviewId}/flag
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/flag' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "up": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "state": true }
PUT

Update app review flag

Updates whether or not the current user has flagged the specified app review. This resource requires authentication.

Request

Path parameters

addonKey

string

Required
reviewId

string

Required

Request bodyapplication/json

_links

BooleanStateRepLinks

state

boolean

Required

Responses

Successfully modified

Headers

Location

string

PUT/addons/{addonKey}/reviews/id/{reviewId}/flag
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 curl --request PUT \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/flag' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json' \ --data '{ "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "up": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "state": true }'
GET

Get app review response

Get the response for the specified app review.

Request

Path parameters

addonKey

string

Required
reviewId

string

Required

Responses

application/json

ReviewResponse
GET/addons/{addonKey}/reviews/id/{reviewId}/response
1 2 3 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/response' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "text": "<string>" }
PUT

Create / update app review response

Create or update a specific app review response. This resource requires authentication.

Request

Path parameters

addonKey

string

Required
reviewId

string

Required

Request bodyapplication/json

_links

SelfLinkOnly

text

string

Required

Responses

Successfully modified

Headers

Location

string

PUT/addons/{addonKey}/reviews/id/{reviewId}/response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 curl --request PUT \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/response' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json' \ --data '{ "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "text": "<string>" }'
DEL

Delete app review response

Delete a specific app review response. This resource requires authentication.

Request

Path parameters

addonKey

string

Required
reviewId

string

Required

Responses

Success

DEL/addons/{addonKey}/reviews/id/{reviewId}/response
1 2 3 curl --request DELETE \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/response' \ --user 'email@example.com:<api_token>'
GET

Get app review upvote

Returns whether or not the current user has upvoted the specified app review. This resource requires authentication.

Request

Path parameters

addonKey

string

Required
reviewId

string

Required

Responses

application/json

BooleanState
GET/addons/{addonKey}/reviews/id/{reviewId}/up
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/up' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "up": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "state": true }
PUT

Update app review upvote

Updates whether or not the current user has upvoted the specified app review. This resource requires authentication.

Request

Path parameters

addonKey

string

Required
reviewId

string

Required

Request bodyapplication/json

_links

BooleanStateRepLinks

state

boolean

Required

Responses

Successfully modified

Headers

Location

string

PUT/addons/{addonKey}/reviews/id/{reviewId}/up
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 curl --request PUT \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/up' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json' \ --data '{ "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "up": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "state": true }'
GET

Get my app review

Get a specific app review written by the current