• 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

Apps

Postman Collection
OpenAPI
GET

Get apps

Get a list of apps matching the specified parameters.

Request

Query parameters

application

string

applicationBuild

integer

category

array<string>

cost

string

filter

string

forThisUser

boolean

hosting

array<string>

includeHidden

string

includePrivate

boolean

marketingLabel

array<string>

Responses

application/json

AddonCollection
GET/addons
1 2 3 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons' \ --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 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "alternate": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "template": "<string>", "type": "<string>", "name": "<string>" }, "byKey": { "template": "<string>", "type": "<string>", "name": "<string>" }, "banners": { "template": "<string>", "type": "<string>", "name": "<string>" }, "next": [ { "href": "<string>", "type": "<string>", "title": "<string>" } ], "prev": [ { "href": "<string>", "type": "<string>", "title": "<string>" } ] }, "_embedded": { "addons": [ { "_links": { "self": { "href": "<string>" }, "alternate": { "href": "<string>" }, "categories": [ { "href": "<string>" } ], "distribution": { "href": "<string>" }, "reviews": [ { "template": "<string>" } ], "vendor": { "href": "<string>" }, "versions": { "href": "<string>" } }, "_embedded": { "categories": [ { "name": "<string>" } ], "distribution": { "bundled": true, "bundledCloud": true, "downloads": 67 }, "reviews": { "averageStars": 23, "count": 23 } }, "name": "<string>", "key": "<string>", "tagLine": "<string>", "summary": "<string>", "status": "private" } ] }, "count": 45 }
POST

Create app

Create a new app.

The associated vendor account must exist prior to the app's creation.

Note that the app's first version should be included in the request body (in _embedded.version).

This resource requires authentication.

Request

Request bodyapplication/json

_links

AddonLinks

Required
_embedded

AddonEmbedded

name

string

Required
key

string

Required
status

string

Required
summary

string

tagLine

string

tags

Tags

vendorLinks

AddonExternalLinks

enableAtlassianAnswers

boolean

Responses

Successfully created

Headers

Location

string

POST/addons
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 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 curl --request POST \ --url 'https://marketplace.atlassian.com/rest/2/addons' \ --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>" }, "banner": { "href": "<string>", "type": "<string>", "title": "<string>" }, "categories": [ { "href": "<string>", "type": "<string>", "title": "<string>" } ], "logo": { "href": "<string>", "type": "<string>", "title": "<string>" }, "support": { "href": "<string>", "type": "<string>", "title": "<string>" }, "titleLogo": { "href": "<string>", "type": "<string>", "title": "<string>" }, "tokens": { "href": "<string>", "type": "<string>", "title": "<string>" }, "distribution": { "href": "<string>", "type": "<string>", "title": "<string>" }, "recommendations": { "template": "<string>", "type": "<string>", "name": "<string>" }, "vendor": { "href": "<string>", "type": "<string>", "title": "<string>" }, "versions": { "href": "<string>", "type": "<string>", "title": "<string>" }, "watch": { "href": "<string>", "type": "<string>", "title": "<string>" }, "approval": { "href": "<string>", "type": "<string>", "title": "<string>" }, "edit": { "href": "<string>", "type": "<string>", "title": "<string>" }, "transition": { "href": "<string>", "type": "<string>", "title": "<string>" }, "release": { "href": "<string>", "type": "<string>", "title": "<string>" }, "feedbacks": { "template": "<string>", "type": "<string>", "name": "<string>" } }, "_embedded": { "banner": { "_links": { "self": { "href": "<string>" }, "image": { "href": "<string>" }, "unscaled": { "href": "<string>" } } }, "logo": { "_links": { "self": { "href": "<string>" }, "image": { "href": "<string>" }, "unscaled": { "href": "<string>" } } }, "titleLogo": { "_links": { "self": { "href": "<string>" }, "image": { "href": "<string>" }, "unscaled": { "href": "<string>" } } }, "distribution": {}, "reviews": { "averageStars": 23, "count": 23 }, "vendor": { "_links": { "self": { "href": "<string>" }, "alternate": { "href": "<string>" } }, "_embedded": {}, "name": "<string>", "verifiedStatus": "flagged", "programs": {}, "isAtlassian": true }, "version": { "_links": {}, "_embedded": {}, "buildNumber": 120, "name": "<string>", "status": "private", "paymentModel": "atlassian", "release": { "beta": true, "supported": true }, "youtubeId": "<string>", "vendorLinks": {}, "compatibilities": [ { "application": "<string>", "hosting": {} } ], "text": {}, "integrationType": "global", "legacy": { "vendorLinks": {} }, "deployment": {}, "cloud": { "appId": "<string>", "appEnvironmentId": "<string>", "appVersionId": "<string>" } } }, "name": "<string>", "key": "<string>", "status": "private", "summary": "<string>", "tagLine": "<string>", "tags": { "category": [ { "id": "<string>", "name": "<string>" } ], "keywords": [ { "id": "<string>", "name": "<string>" } ] }, "vendorLinks": { "issueTracker": "<string>", "supportTicketSystem": "<string>", "appStatusPage": "<string>", "forums": "<string>", "privacy": "<string>" }, "enableAtlassianAnswers": true, "googleAnalyticsId": "<string>", "legacy": { "description": "<string>", "vendorLinks": { "wiki": "<string>", "source": "<string>", "builds": "<string>" } }, "marketing": { "marketingLabels": [ "<string>" ] }, "statusAfterApproval": "private", "communityEnabled": true, "jsdEmbeddedDataKey": "<string>", "dataCenterReviewIssueKey": "<string>" }'
GET

Get archived apps

Get a list of archived apps matching the specified parameters.

Request

Query parameters

application

string

applicationBuild

integer

category

array<string>

cost

string

filter

string

forThisUser

boolean

hosting

array<string>

includeHidden

string

includePrivate

boolean

marketingLabel

array<string>

Responses

application/json

AddonListingCollection
GET/addons/archived
1 2 3 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/archived' \ --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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "alternate": { "href": "<string>", "type": "<string>", "title": "<string>" }, "prev": { "href": "<string>", "type": "<string>", "title": "<string>" }, "next": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "_embedded": { "addons": [ { "_links": { "self": { "href": "<string>" }, "alternate": { "href": "<string>" }, "vendor": { "href": "<string>" } }, "_embedded": {}, "key": "<string>", "name": "<string>", "lastModified": "<string>" } ] }, "count": 45 }
GET

Get archived apps (by vendor)

Get a list of archived apps by a specific vendor matching the specified parameters.

Request

Path parameters

vendorId

integer

Required

Query parameters

application

string

applicationBuild

integer

category

array<string>

cost

string

filter

string

forThisUser

boolean

hosting

array<string>

includeHidden

string

includePrivate

boolean

marketingLabel

array<string>

Responses

application/json

AddonListingCollection
GET/addons/archived/vendor/{vendorId}
1 2 3 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/archived/vendor/{vendorId}' \ --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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "alternate": { "href": "<string>", "type": "<string>", "title": "<string>" }, "prev": { "href": "<string>", "type": "<string>", "title": "<string>" }, "next": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "_embedded": { "addons": [ { "_links": { "self": { "href": "<string>" }, "alternate": { "href": "<string>" }, "vendor": { "href": "<string>" } }, "_embedded": {}, "key": "<string>", "name": "<string>", "lastModified": "<string>" } ] }, "count": 45 }
GET

Get app banners

Get a list of app banners matching the specified parameters.

Request

Query parameters

application

string

applicationBuild

integer

category

array<string>

cost

string

filter

string

forThisUser

boolean

hosting

array<string>

includeHidden

string

includePrivate

boolean

marketingLabel

array<string>

Responses

application/json

AddonListingCollection
GET/addons/listings/banners
1 2 3 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/listings/banners' \ --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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "alternate": { "href": "<string>", "type": "<string>", "title": "<string>" }, "prev": { "href": "<string>", "type": "<string>", "title": "<string>" }, "next": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "_embedded": { "addons": [ { "_links": { "self": { "href": "<string>" }, "alternate": { "href": "<string>" }, "vendor": { "href": "<string>" } }, "_embedded": {}, "key": "<string>", "name": "<string>", "lastModified": "<string>" } ] }, "count": 45 }
GET

Get apps (brief)

Get a list of apps with names matching a search term. This resource's responses are limited to just a single page of results. Use the app collection resource (/rest/2/addons) for more results.

Request

Query parameters

q

string

Responses

application/json

BriefSearchResult
GET/addons/search/brief
1 2 3 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/search/brief' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 { "addons": [ { "name": "<string>", "key": "<string>", "_links": { "alternate": { "href": "<string>" }, "logo": { "href": "<string>" } } } ] }
GET

Get apps (by vendor)

Get a list of apps for the specified vendor.

Request

Path parameters

vendorId

integer

Required

Query parameters

application

string

applicationBuild

integer

category

array<string>

cost

string

filter

string

forThisUser

boolean

hosting

array<string>

includeHidden

string

includePrivate

boolean

marketingLabel

array<string>

Responses

application/json

AddonCollection
GET/addons/vendor/{vendorId}
1 2 3 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/vendor/{vendorId}' \ --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 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "alternate": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "template": "<string>", "type": "<string>", "name": "<string>" }, "byKey": { "template": "<string>", "type": "<string>", "name": "<string>" }, "banners": { "template": "<string>", "type": "<string>", "name": "<string>" }, "next": [ { "href": "<string>", "type": "<string>", "title": "<string>" } ], "prev": [ { "href": "<string>", "type": "<string>", "title": "<string>" } ] }, "_embedded": { "addons": [ { "_links": { "self": { "href": "<string>" }, "alternate": { "href": "<string>" }, "categories": [ { "href": "<string>" } ], "distribution": { "href": "<string>" }, "reviews": [ { "template": "<string>" } ], "vendor": { "href": "<string>" }, "versions": { "href": "<string>" } }, "_embedded": { "categories": [ { "name": "<string>" } ], "distribution": { "bundled": true, "bundledCloud": true, "downloads": 67 }, "reviews": { "averageStars": 23, "count": 23 } }, "name": "<string>", "key": "<string>", "tagLine": "<string>", "summary": "<string>", "status": "private" } ] }, "count": 45 }
GET

Get app

Get a specific app.

Request

Path parameters

addonKey

string

Required

Query parameters

application

string

applicationBuild

integer

category

array<string>

cost

string

filter

string

forThisUser

boolean

hosting

array<string>

includeHidden

string

includePrivate

boolean

marketingLabel

array<string>

Responses

application/json

Addon
GET/addons/{addonKey}
1 2 3 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}' \ --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 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "alternate": { "href": "<string>", "type": "<string>", "title": "<string>" }, "banner": { "href": "<string>", "type": "<string>", "title": "<string>" }, "categories": [ { "href": "<string>", "type": "<string>", "title": "<string>" } ], "logo": { "href": "<string>", "type": "<string>", "title": "<string>" }, "pricing": [ { "href": "<string>", "type": "<string>", "name": "<string>", "templated": true } ], "support": { "href": "<string>", "type": "<string>", "title": "<string>" }, "titleLogo": { "href": "<string>", "type": "<string>", "title": "<string>" }, "tokens": { "href": "<string>", "type": "<string>", "title": "<string>" }, "distribution": { "href": "<string>", "type": "<string>", "title": "<string>" }, "recommendations": { "template": "<string>", "type": "<string>", "name": "<string>" }, "reviews": [ { "template": "<string>", "type": "<string>", "name": "<string>" } ], "vendor": { "href": "<string>", "type": "<string>", "title": "<string>" }, "versions": { "href": "<string>", "type": "<string>", "title": "<string>" }, "watch": { "href": "<string>", "type": "<string>", "title": "<string>" }, "approval": { "href": "<string>", "type": "<string>", "title": "<string>" }, "edit": { "href": "<string>", "type": "<string>", "title": "<string>" }, "transition": { "href": "<string>", "type": "<string>", "title": "<string>" }, "release": { "href": "<string>", "type": "<string>", "title": "<string>" }, "feedbacks": { "template": "<string>", "type": "<string>", "name": "<string>" } }, "_embedded": { "banner": { "_links": { "self": { "href": "<string>" }, "image": { "href": "<string>" }, "unscaled": { "href": "<string>" } } }, "categories": [ { "_links": { "self": { "href": "<string>" } }, "name": "<string>" } ], "logo": { "_links": { "self": { "href": "<string>" }, "image": { "href": "<string>" }, "unscaled": { "href": "<string>" } } }, "titleLogo": { "_links": { "self": { "href": "<string>" }, "image": { "href": "<string>" }, "unscaled": { "href": "<string>" } } }, "distribution": { "bundled": true, "bundledCloud": true, "downloads": 67, "totalInstalls": 112, "totalUsers": 84 }, "reviews": { "averageStars": 23, "count": 23 }, "vendor": { "_links": { "self": { "href": "<string>" }, "alternate": { "href": "<string>" } }, "_embedded": {}, "name": "<string>", "verifiedStatus": "flagged", "programs": {}, "isAtlassian": true }, "version": { "_links": {}, "_embedded": {}, "buildNumber": 120, "name": "<string>", "status": "private", "paymentModel": "atlassian", "release": { "beta": true, "supported": true }, "youtubeId": "<string>", "vendorLinks": {}, "compatibilities": [ { "application": "<string>", "hosting": {} } ], "text": {}, "static": true, "deployable": true, "integrationType": "global", "legacy": { "vendorLinks": {} }, "deployment": { "server": true, "cloud": true, "connect": true, "autoUpdateAllowed": true, "permissions": [ { "_links": { "alternate": { "href": "<string>" } }, "key": "<string>", "name": "<string>", "description": "<string>" } ], "dataCenter": true }, "cloud": { "appId": "<string>", "appEnvironmentId": "<string>", "appVersionId": "<string>" } } }, "name": "<string>", "key": "<string>", "status": "private", "summary": "<string>", "tagLine": "<string>", "tags": { "category": [ { "id": "<string>", "name": "<string>" } ], "keywords": [ { "id": "<string>", "name": "<string>" } ], "marketing": [ { "id": "<string>", "name": "<string>" } ] }, "vendorLinks": { "issueTracker": "<string>", "supportTicketSystem": "<string>", "appStatusPage": "<string>", "forums": "<string>", "privacy": "<string>" }, "enableAtlassianAnswers": true, "googleAnalyticsId": "<string>", "legacy": { "description": "<string>", "vendorLinks": { "wiki": "<string>", "source": "<string>", "builds": "<string>" } }, "marketing": { "marketingLabels": [ "<string>" ] }, "lastModified": "<string>", "codegeist": true, "statusAfterApproval": "private", "communityEnabled": true, "jsdEmbeddedDataKey": "<string>", "dataCenterReviewIssueKey": "<string>" }
PATCH

Update app

Update a specific app.

The request body must be a valid JSON Patch document. The properties which can be referenced in the PATCH are the same ones returned by a GET on this URI.

This resource requires authentication.

Request

Path parameters

addonKey

string

Required

Request bodyapplication/json-patch+json

The request body must be a valid JSON Patch document. The properties which can be referenced in the PATCH are the same ones returned by a GET on this URI.

array<JsonPatchDocumentation>

op

string

Required
path

string

Required
value

object

from

string

Responses

Successfully modified

Headers

Location

string

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

Get app approval

Get a specific app approval status. This resource requires authentication.

Request

Path parameters

addonKey

string

Required

Responses

application/json

ApprovalStatus
GET/addons/{addonKey}/approval
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/approval' \ --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 16 17 18 19 20 21 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "parent": { "href": "<string>", "type": "<string>", "title": "<string>" }, "issuePortal": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "status": "approved", "reason": "<string>" }
PUT

Update app approval

Approve, reject or resubmit an app for approval.

Vendors can use this resource to resubmit a previously rejected app for approval. This is done by setting the status field to pending.

Administrators can use this resource to approve or reject an app that is submitted for approval.

This resource requires authentication.

Request

Path parameters

addonKey

string

Required

Request bodyapplication/json

_links

ApprovalStatusLinks

status

string

Required
reason

string

Responses

Invalid properties

application/json

JsonErrorsDoc
PUT/addons/{addonKey}/approval
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 curl --request PUT \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/approval' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json' \ --data '{ "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "parent": { "href": "<string>", "type": "<string>", "title": "<string>" }, "issuePortal": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "status": "approved", "reason": "<string>" }'
400Response
1 2 3 4 5 6 7 8 9 { "errors": [ { "message": "<string>", "path": "<string>", "code": "<string>" } ] }
GET

Get app metrics

Get a summary of an app's latest metrics.

Request

Path parameters

addonKey

string

Required

Responses

application/json

AddonDistributionSummary

Summary information about an app's installation distribution

GET/addons/{addonKey}/distribution
1 2 3 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 { "bundled": true, "bundledCloud": true, "downloads": 67, "totalInstalls": 112, "totalUsers": 84 }
GET

Get app active installations

Get a specific app's active installation counts over time. This resource requires authentication.

Request

Path parameters

addonKey

string

Required

Responses

application/json

AddonDistribution

Detailed information about an app's distribution

GET/addons/{addonKey}/distribution/active
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution/active' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 { "series": [ { "name": "<string>", "elements": [ { "date": "<string>", "count": 63 } ] } ] }
GET

Get app active installations (by application)

Get a specific app's active installation counts over time, aggregated by application. This resource requires authentication.

Request

Path parameters

addonKey

string

Required

Responses

application/json

AddonDistribution

Detailed information about an app's distribution

GET/addons/{addonKey}/distribution/application
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution/application' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 { "series": [ { "name": "<string>", "elements": [ { "date": "<string>", "count": 63 } ] } ] }
GET

Get app active installations (by application version)

Get a specific app's active installation counts over time, aggregated by application version. This resource requires authentication.

Request

Path parameters

addonKey

string

Required

Responses

application/json

AddonDistribution

Detailed information about an app's distribution

GET/addons/{addonKey}/distribution/application/version
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution/application/version' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 { "series": [ { "name": "<string>", "elements": [ { "date": "<string>", "count": 63 } ] } ] }
GET

Get app active installations (by major application version)

Get a specific app's active installation counts over time, aggregated by major application version. This resource requires authentication.

Request

Path parameters

addonKey

string

Required

Responses

application/json

AddonDistribution

Detailed information about an app's distribution

GET/addons/{addonKey}/distribution/application/version/major
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution/application/version/major' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 { "series": [ { "name": "<string>", "elements": [ { "date": "<string>", "count": 63 } ] } ] }
GET

Get app active installations (by minor application version)

Get a specific app's active installation counts over time, aggregated by minor application version. This resource requires authentication.

Request

Path parameters

addonKey

string

Required

Responses

application/json

AddonDistribution

Detailed information about an app's distribution

GET/addons/{addonKey}/distribution/application/version/minor
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution/application/version/minor' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 { "series": [ { "name": "<string>", "elements": [ { "date": "<string>", "count": 63 } ] } ] }
GET

Get app active installations (by app version)

Get a specific app's active installation counts over time, aggregated by app version. This resource requires authentication.

Request

Path parameters

addonKey

string

Required

Responses

application/json

AddonDistribution

Detailed information about an app's distribution

GET/addons/{addonKey}/distribution/version
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution/version' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 { "series": [ { "name": "<string>", "elements": [ { "date": "<string>", "count": 63 } ] } ] }
GET

Get app feedback

Get a list of app feedback matching the specified parameters. This resource requires authentication.

Request

Path parameters

addonKey

string

Required

Query parameters

type

string

includeAnonymous

boolean

reason

string

offset

integer

limit

integer

Responses

application/json

AddonFeedbackCollection

A collection of feedback received for the app

GET/addons/{addonKey}/feedbacks
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/feedbacks' \ --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 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "distributions": { "template": "<string>", "type": "<string>", "name": "<string>" }, "next": { "href": "<string>", "type": "<string>", "title": "<string>" }, "prev": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "feedbacks": [ { "version": "<string>", "time": "<string>", "feedbackType": "disable", "reasonCode": "bugs", "message": "<string>", "email": "<string>", "fullName": "<string>", "addonSen": "<string>" } ] }
GET

Get aggregated app feedback

Get aggregated feedback for the specified app, aggregated by the specified metric. Feedback can be aggregated by type. This resource requires authentication.

Request

Path parameters

addonKey

string

Required

Query parameters

type

string

Required
startDate

string

endDate

string

Responses

application/json

AddonFeedbackDistribution

Detailed information about an app's feedback distribution

GET/addons/{addonKey}/feedbacks/distribution
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/feedbacks/distribution?type={type}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 { "series": [ { "name": "<string>", "elements": [ { "date": "<string>", "count": 61 } ] } ] }
GET

Get app pricing

Get pricing for the specified app. Live pricing is visible to all users. Pending pricing is only visible if you are authenticated as a vendor contact.

Request

Path parameters

addonKey

string

Required
cloudOrServer

string

Required
liveOrPending

string

Required

Responses

application/json

Pricing
GET/addons/{addonKey}/pricing/{cloudOrServer}/{liveOrPending}
1 2 3 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/pricing/{cloudOrServer}/{liveOrPending}' \ --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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "items": [ { "description": "<string>", "editionId": "<string>", "editionDescription": "<string>", "editionType": "<string>", "amount": 67, "renewalAmount": 134, "unitCount": 123, "monthsValid": 70, "licenseType": "<string>" } ], "perUnitItems": [ { "description": "<string>", "editionId": "<string>", "editionDescription": "<string>", "editionType": "<string>", "amount": 67, "renewalAmount": 134, "unitCount": 123, "monthsValid": 70, "licenseType": "<string>" } ], "expertDiscountOptOut": true, "contactSalesForAdditionalPricing": true, "parent": "<string>", "lastModified": "<string>", "status": "live", "default": true, "hasPublishedPrices": true, "canChangePrices": true, "role": { "singularName": "<string>", "pluralName": "<string>" } }
PUT

Submit app pricing

Update pricing for the specified app.

Updated pricing is always initially in the "pending" state.

For an app pending approval, pricing changes will go "live" when the app is approved. For an already-approved app, pricing changes will go "live" after 24 hours.

This resource requires authentication.

Request

Path parameters

addonKey

string

Required
cloudOrServer

string

Required
liveOrPending

string

Required

Request bodyapplication/json

_links

SelfLinkOnly

items

array<PricingItem>

Required
perUnitItems

array<PricingItem>

expertDiscountOptOut

boolean

Required
role

AddonRole

Deprecated

Responses

application/json

Pricing
PUT/addons/{addonKey}/pricing/{cloudOrServer}/{liveOrPending}
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 curl --request PUT \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/pricing/{cloudOrServer}/{liveOrPending}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "items": [ { "amount": 67, "unitCount": 123, "monthsValid": 70, "licenseType": "<string>" } ], "perUnitItems": [ { "amount": 67, "unitCount": 123, "monthsValid": 70, "licenseType": "<string>" } ], "expertDiscountOptOut": true, "role": { "singularName": "<string>", "pluralName": "<string>" } }'
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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "items": [ { "description": "<string>", "editionId": "<string>", "editionDescription": "<string>", "editionType": "<string>", "amount": 67, "renewalAmount": 134, "unitCount": 123, "monthsValid": 70, "licenseType": "<string>" } ], "perUnitItems": [ { "description": "<string>", "editionId": "<string>", "editionDescription": "<string>", "editionType": "<string>", "amount": 67, "renewalAmount": 134, "unitCount": 123, "monthsValid": 70, "licenseType": "<string>" } ], "expertDiscountOptOut": true, "contactSalesForAdditionalPricing": true, "parent": "<string>", "lastModified": "<string>", "status": "live", "default": true, "hasPublishedPrices": true, "canChangePrices": true, "role": { "singularName": "<string>", "pluralName": "<string>" } }
GET

Get app recommendations

Get apps recommended to users of the specified app.

Request

Path parameters

addonKey

string

Required

Query parameters

application

string

applicationBuild

integer

category

array<string>

cost

string

filter

string

forThisUser

boolean

hosting

array<string>

includeHidden

string

includePrivate

boolean

marketingLabel

array<string>

Responses

application/json

AddonListingCollection
GET/addons/{addonKey}/recommendations
1 2 3 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/recommendations' \ --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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "alternate": { "href": "<string>", "type": "<string>", "title": "<string>" }, "prev": { "href": "<string>", "type": "<string>", "title": "<string>" }, "next": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "_embedded": { "addons": [ { "_links": { "self": { "href": "<string>" }, "alternate": { "href": "<string>" }, "vendor": { "href": "<string>" } }, "_embedded": {}, "key": "<string>", "name": "<string>", "lastModified": "<string>" } ] }, "count": 45 }
GET

Get app release status

Get a specific app's release status. This resource requires authentication.

Request

Path parameters

addonKey

string

Required

Responses

application/json

AddonReleaseStatus
GET/addons/{addonKey}/release
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/release' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 { "released": true }
PUT

Release app

Release an app after it has been approved.

If a vendor requests that their app is not automatically released after it has been approved, they can use this resource to release their app.

Set the released field to true. This only works one-way; vendors cannot set it to false later.

This resource requires authentication.

Request

Path parameters

addonKey

string

Required

Request bodyapplication/json

released

boolean

Required

Responses

Invalid properties

application/json

JsonErrorsDoc
PUT/addons/{addonKey}/release
1 2 3 4 5 6 7 curl --request PUT \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/release' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json' \ --data '{ "released": true }'
400Response
1 2 3 4 5 6 7 8 9 { "errors": [ { "message": "<string>", "path": "<string>", "code": "<string>" } ] }
GET

Get access tokens

Get a list of access tokens for the specified app. In addition to vendor contacts, anonymous users can access this resource if they provide an existing valid token.

Request

Path parameters

addonKey

string

Required

Responses

application/json

TokenCollection
GET/addons/{addonKey}/tokens
1 2 3 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/tokens' \ --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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "descriptor": { "href": "<string>", "type": "<string>", "title": "<string>" }, "byToken": { "template": "<string>", "type": "<string>", "name": "<string>" } }, "_embedded": { "tokens": [ { "_links": { "self": { "href": "<string>" }, "descriptor": [ { "href": "<string>" } ] }, "token": "<string>", "instance": "<string>" } ] } }
POST

Create access token

Create a new access token. This resource requires authentication.

Request

Path parameters

addonKey

string

Required

Responses

application/json

Token
POST/addons/{addonKey}/tokens
1 2 3 4 curl --request POST \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/tokens' \ --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 16 17 18 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "descriptor": [ { "href": "<string>", "type": "<string>", "title": "<string>" } ] }, "token": "<string>", "instance": "<string>" }
GET

Get access token

Get a specific access token. This resource requires authentication.

Request

Path parameters

addonKey

string

Required
token

string

Required

Responses

application/json

Token
GET/addons/{addonKey}/tokens/{token}
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/tokens/{token}' \ --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 16 17 18 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "descriptor": [ { "href": "<string>", "type": "<string>", "title": "<string>" } ] }, "token": "<string>", "instance": "<string>" }
POST

Validate access token

Validates or associates an access token with a host.

For a new access token, this resource associates the token with a host. For tokens already associated with a host, this resource validates that the Origin header matches the associated host. The host is specified by the request's Origin header.

Request

Path parameters

addonKey

string

Required
token

string

Required

Responses

Success

POST/addons/{addonKey}/tokens/{token}
1 2 curl --request POST \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/tokens/{token}'
DEL

Delete access token

Delete a specific access token. This resource requires authentication.

Request

Path parameters

addonKey

string

Required
token

string

Required

Responses

application/json

Token
DEL/addons/{addonKey}/tokens/{token}
1 2 3 4 curl --request DELETE \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/tokens/{token}' \ --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 16 17 18 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "descriptor": [ { "href": "<string>", "type": "<string>", "title": "<string>" } ] }, "token": "<string>", "instance": "<string>" }
GET

Get watch/unwatch app state

Returns whether or not the current user is watching the specified app. This resource requires authentication.

Request

Path parameters

addonKey

string

Required

Responses

application/json

BooleanState
GET/addons/{addonKey}/watch
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/watch' \ --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

Watch / unwatch app

Updates whether or not the current user is watching the specified app. This resource requires authentication.

Request

Path parameters

addonKey

string

Required

Request bodyapplication/json

_links

BooleanStateRepLinks

state

boolean

Required

Responses

Successfully modified

Headers

Location

string

PUT/addons/{addonKey}/watch
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}/watch' \ --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 }'

Rate this page: