Information about app reviews
Get a list of reviews for the specified app.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
integer
integer
string
1
2
3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews' \
--header 'Accept: application/json'
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
}
Create or update a specific app review. This resource requires authentication.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredReviewLinks
ReviewEmbedded
string
integer
RequiredSuccessfully modified
string
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 a specific app review.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Required1
2
3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}' \
--header 'Accept: application/json'
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"
}
Create or update a specific app review.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredReviewLinks
ReviewEmbedded
string
integer
RequiredSuccessfully modified
string
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
}'
Delete a specific app review.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredSuccess
1
2
curl --request DELETE \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}'
Returns whether or not the current user has downvoted the specified app review. This resource requires authentication.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Required1
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'
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
}
Updates whether or not the current user has downvoted the specified app review. This resource requires authentication.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredBooleanStateRepLinks
boolean
RequiredSuccessfully modified
string
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
}'
Returns whether or not the current user has flagged the specified app review. This resource requires authentication.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Required1
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'
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
}
Updates whether or not the current user has flagged the specified app review. This resource requires authentication.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredBooleanStateRepLinks
boolean
RequiredSuccessfully modified
string
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 the response for the specified app review.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Required1
2
3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/response' \
--header 'Accept: application/json'
1
2
3
4
5
6
7
8
9
10
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"text": "<string>"
}
Create or update a specific app review response. This resource requires authentication.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredSelfLinkOnly
string
RequiredSuccessfully modified
string
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>"
}'
Delete a specific app review response. This resource requires authentication.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredSuccess
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>'
Returns whether or not the current user has upvoted the specified app review. This resource requires authentication.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Required1
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'
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
}
Updates whether or not the current user has upvoted the specified app review. This resource requires authentication.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredBooleanStateRepLinks
boolean
RequiredSuccessfully modified
string
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 a specific app review written by the current user. This resource requires authentication.
Forge and OAuth2 apps cannot access this REST resource.
string
Required1
2
3
4
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/mine' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'
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"
}
Create or update a specific app review written by the current user. This resource requires authentication.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredReviewLinks
ReviewEmbedded
string
integer
RequiredSuccessfully modified
string
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 PUT \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/mine' \
--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
}'
Delete a specific app review written by the current user. This resource requires authentication.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredSuccess
1
2
3
curl --request DELETE \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/mine' \
--user 'email@example.com:<api_token>'
Rate this page: