About

The Marketplace API is a RESTful API that allows you to manage apps and your vendor account.

Unsure about the types exposed in this API? Read more about our terminology.

Versioning

Version 2 is the latest release of the Marketplace API. Scroll down to view the latest API documentation for this version.

Authentication

The Marketplace API uses HTTP basic authentication and your Atlassian account. Once authenticated, you can view and modify most properties of your apps and your account. If you are not logged in, you are considered an unauthenticated user and will not be able to edit apps or vendor information.

URI structure

All Uniform Resource Identifiers (URIs) start with the following prefix:

https://marketplace.atlassian.com/rest/2

When a resource provides a link to another resource, the link URI will not include the hostname (for instance, the link will be /rest/2/addons rather than https://marketplace.atlassian.com/rest/2/addons).

URIs referring to content that is not provided by Atlassian Marketplace are always absolute (that is, they use http:// or https://) and are encoded as ordinary string properties.

Request format

All request and response representations are in JSON and use the content type application/json with the UTF-8 character set, except for PATCH requests.

The Marketplace API uses standard HTTP methods. Successful POST, PUT, and PATCH requests return a Location header in addition to the HTTP status codes documented below. Successful DELETE requests return only the status code. See the Errors section for information about responses that return an error.

Method Description Successful response
GET All GET requests are idempotent. 200
POST Creates a new entity. 201
PUT Modifies all editable properties of existing entity. It cannot be applied to a collection resource. 204
PATCH Modifies only selected properties of an existing entity. It cannot be applied to a collection resource. Request bodies use the JSON Patch document structure with the content type application/json-patch+json. 204
DELETE Removes an entity. It cannot be applied to a collection resource and accepts no request body. 204

Pagination

The Marketplace API uses pagination to limit response size for resources that may return large numbers of results. HTTP clients may specify a smaller page size of N by adding the query parameter limit=N. A client may also specify a starting offset for a paginated resource by adding the query parameter offset=N, meaning that the first N items are skipped. Non-paginated resources ignore the limit and offset parameters:

  • offset (optional) - Specifies the number of items to skip. The default value is 0.
  • limit (optional) - Specifies the maximum page size, between 0 and 50, with a default value of 10. Setting limit=0 returns only the overall properties of a collection resource, such as the total number of available items, without getting the properties of any individual item.

If the limit argument fails to validate, the API may respond with an error like the example below:

{
    errors: [
        {
            message: "limit: Must be an integer"
        }
    ]
}

Response format

All resources containing links to Atlassian Marketplace resources and web pages use the HAL specification with JSON (with some extensions as described below under POST and PUT, for cases that HAL does not cover). Such links will always be within a top-level _links or _embedded object. External links provided by third parties are considered simple data properties and can appear anywhere in a representation.

All resource links should:

  • be relative to the host root, for example, /rest/2/addons.
  • have a self link referring to themselves.

Links to the Marketplace website may be absolute or relative URIs. External links must always be absolute URIs.

When available, paginated responses provide the next and prev links to retrieve the next or previous page of items:

  • next Retrieves the next page of items.
  • prev Retrieves the previous page of items.

Dates

All dates referenced by the API are in Coordinated Universal Time (UTC).

Errors

The following response status codes may be accompanied by an error representation.

Status Description
400 Request body is malformed or has an illegal property value.
401 Authentication is required.
403 User was authenticated but is not authorized for this operation.
404 Resource does not exist or is not visible to this user.
409 Resource cannot be created or modified due to some state constraint.
500 Unexpected internal error in the Atlassian Marketplace.
502 Unexpected error in an external service.

Error responses may contain a JSON representation with a single top-level property, errors, that contains an array of objects (each with a message) and optional path and code properties. The path uses JSON Pointer format to refer to an invalid field in the request representation. If path is not present, the message describes a general condition that isn’t tied to a specific field. If present, the code is a string that uniquely identifies the type of error. An example appears below:

{
    "errors": [
        { "message": "There is a general problem." },
        { "path": "/name", "message": "cannot be longer than 5000 characters" }
    ]
}

AddonCategories

Get category

GET /rest/2/addonCategories/{pluginCategoryId}

Get a specific category.

Response content type: application/json

Request

Path parameters

pluginCategoryId REQUIRED

integer

The unique identifier for this category

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addonCategories/{pluginCategoryId}'

Response

404 Not Found

The resource does not exist

Get categories

GET /rest/2/addonCategories/app/{applicationKey}

Get a list of categories associated with the parent application.

For non-UPM clients, this resource returns all categories regardless of the specified application.

Response content type: application/json

Request

Path parameters

applicationKey REQUIRED

string

The unique identifier for this application, for example “jira”

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addonCategories/app/{applicationKey}'

Response

404 Not Found

The resource does not exist

Addons

Get apps

GET /rest/2/addons

Get a list of apps matching the specified parameters.

Response content type: application/json

Request

Query parameters

application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

category

[string]

Only returns apps with any of the specified categories

cost

string

Only returns apps with the specified payment model

Valid values:
  • free
  • paid
  • marketplace
  • orderable

filter

string

Return apps filtered or sorted using the specified parameter

Valid values:
  • featured
  • highest-rated
  • recent
  • new
  • popular
  • top-grossing
  • trending
  • atlassian
  • codegeist
  • verified
  • name

forThisUser

boolean

Only returns apps from vendors associated with the current user

hosting

string

Only returns apps with the specified hosting model

Valid values:
  • cloud
  • server
  • datacenter
  • any

includeHidden

string

Includes apps that are normally hidden in the site

Valid values:
  • visibleInApp
  • all

includePrivate

boolean

Includes private apps or versions if you are authorized to see them

limit

integer

If specified, limits the result set to this number of items

marketingLabel

[string]

Only returns apps with the specified marketing labels

offset

integer

If specified, skips ahead by this number of items

text

string

Only returns apps that match the search text

withVersion

boolean

Includes the latest compatible version in the response

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons'

Response

Create app

POST /rest/2/addons

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.

Response content type: application/json

Request

Body parameters

_embedded

AddonEmbedded

AddonLinks

codegeist

boolean

True if this app is an entry to the Atlassian Codegeist competition

communityEnabled

boolean

To enable and disable showing the Atlassian Comunity Link for a supported app

enableAtlassianAnswers

boolean

This field is deprecated and will always be empty. If specified in a request body, it’ll be ignored’

googleAnalyticsId

string

Google Analytics account ID for tracking visitors to the app page

jsdEmbeddedDataKey

string

The data key that associates the Jira Service Desk Widget with a specific Jira Service Desk project

key

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

lastModified

string

Date and time the app was last updated

legacy

AddonLegacyProperties

marketing

AddonMarketingProperties

name

string

The display name of the app, for example “Questions for Confluence”

status

string

Indicates whether the app is public, private, or pending approval

Valid values:
  • private
  • submitted
  • readytolaunch
  • public
  • rejected

statusAfterApproval

string

The status the app will transition to after it has been approved. If not specified, this will be Public

Valid values:
  • private
  • submitted
  • readytolaunch
  • public
  • rejected

summary

string

Summary of the app’s functionality

tagLine

string

Short phrase that summarizes what the app does and will be displayed as a heading on the app details page

AddonExternalLinks

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json' \
  --data '
    {
      "_embedded": {
        "banner": {
          "_links": {
            "highRes": {},
            "image": {},
            "self": {},
            "smallHighResImage": {},
            "smallImage": {},
            "unscaled": {}
          }
        },
        "categories": [
          {
            "_links": {
              "self": {}
            },
            "name": "string"
          }
        ],
        "distribution": {
          "bundled": true,
          "downloads": 123456,
          "totalInstalls": 123456,
          "totalUsers": 123456
        },
        "logo": {},
        "reviews": {
          "averageStars": 123.456,
          "count": 123456
        },
        "titleLogo": {},
        "vendor": {
          "_embedded": {
            "logo": {}
          },
          "_links": {
            "alternate": {},
            "edit": {},
            "logo": {},
            "self": {}
          },
          "name": "string",
          "verifiedStatus": "string"
        },
        "version": {
          "_embedded": {
            "artifact": {
              "_links": {
                "binary": {},
                "remote": {},
                "self": {}
              }
            },
            "functionalCategories": [
              {}
            ],
            "hero": {},
            "highlights": [
              {
                "_embedded": {
                  "screenshot": {},
                  "thumbnail": {}
                },
                "_links": {
                  "screenshot": {},
                  "thumbnail": {}
                },
                "body": "string",
                "explanation": "string",
                "title": "string"
              }
            ],
            "instructions": [
              {
                "_embedded": {
                  "image": {}
                },
                "_links": {
                  "image": {}
                },
                "body": "string"
              }
            ],
            "license": {
              "_links": {
                "alternate": {},
                "self": {}
              },
              "key": "string",
              "name": "string"
            },
            "screenshots": [
              {
                "_embedded": {
                  "image": {}
                },
                "_links": {
                  "image": {}
                },
                "caption": "string"
              }
            ]
          },
          "_links": {
            "agreement": {},
            "alternate": {},
            "approval": {},
            "artifact": {},
            "edit": {},
            "functionalCategories": [
              {}
            ],
            "hero": {},
            "license": {},
            "self": {},
            "transition": {}
          },
          "buildNumber": 123456,
          "compatibilities": [
            {
              "application": "string",
              "hosting": {
                "cloud": true,
                "server": {
                  "max": {},
                  "min": {
                    "build": 123456,
                    "version": "string"
                  }
                }
              }
            }
          ],
          "deployable": true,
          "deployment": {
            "autoUpdateAllowed": true,
            "cloud": true,
            "connect": true,
            "dataCenter": true,
            "permissions": [
              {
                "_links": {
                  "alternate": {}
                },
                "description": "string",
                "key": "string",
                "name": "string"
              }
            ],
            "server": true
          },
          "integrationType": "string",
          "legacy": {
            "vendorLinks": {
              "donate": "string",
              "evaluationLicense": "string",
              "javadocs": "string",
              "releaseNotes": "string",
              "source": "string"
            }
          },
          "name": "string",
          "paymentModel": "string",
          "release": {
            "beta": true,
            "date": "string",
            "releasedBy": "string",
            "supported": true
          },
          "static": true,
          "status": "string",
          "text": {
            "moreDetails": "string",
            "releaseNotes": "string",
            "releaseSummary": "string"
          },
          "vendorLinks": {
            "binary": "string",
            "documentation": "string",
            "eula": "string",
            "learnMore": "string",
            "license": "string",
            "purchase": "string",
            "releaseNotes": "string"
          },
          "youtubeId": "string"
        }
      },
      "_links": {
        "alternate": {},
        "approval": {},
        "banner": {},
        "categories": [
          {}
        ],
        "distribution": {},
        "edit": {},
        "feedbacks": {},
        "logo": {},
        "pricing": [
          {
            "name": "string",
            "template": "string",
            "type": "string"
          }
        ],
        "recommendations": {},
        "release": {},
        "reviews": [
          {}
        ],
        "self": {
          "href": "string",
          "title": "string",
          "type": "string"
        },
        "support": {},
        "titleLogo": {},
        "tokens": {},
        "transition": {},
        "vendor": {},
        "versions": {},
        "watch": {}
      },
      "codegeist": true,
      "communityEnabled": true,
      "enableAtlassianAnswers": true,
      "googleAnalyticsId": "string",
      "jsdEmbeddedDataKey": "string",
      "key": "string",
      "lastModified": "string",
      "legacy": {
        "description": "string",
        "vendorLinks": {
          "builds": "string",
          "source": "string",
          "wiki": "string"
        }
      },
      "marketing": {
        "marketingLabels": [
          "string"
        ]
      },
      "name": "string",
      "status": "string",
      "statusAfterApproval": "string",
      "summary": "string",
      "tagLine": "string",
      "vendorLinks": {
        "appStatusPage": "string",
        "forums": "string",
        "issueTracker": "string",
        "privacy": "string",
        "supportTicketSystem": "string"
      }
    }' \
  --url 'https://marketplace.atlassian.com/rest/2/addons'

Response

201 Created

Successfully created

Invalid properties

Get app

GET /rest/2/addons/{addonKey}

Get a specific app.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Query parameters

application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

category

[string]

Only returns apps with any of the specified categories

cost

string

Only returns apps with the specified payment model

Valid values:
  • free
  • paid
  • marketplace
  • orderable

filter

string

Return apps filtered or sorted using the specified parameter

Valid values:
  • featured
  • highest-rated
  • recent
  • new
  • popular
  • top-grossing
  • trending
  • atlassian
  • codegeist
  • verified
  • name

forThisUser

boolean

Only returns apps from vendors associated with the current user

hosting

string

Only returns apps with the specified hosting model

Valid values:
  • cloud
  • server
  • datacenter
  • any

includeHidden

string

Includes apps that are normally hidden in the site

Valid values:
  • visibleInApp
  • all

includePrivate

boolean

Includes private apps or versions if you are authorized to see them

marketingLabel

[string]

Only returns apps with the specified marketing labels

text

string

Only returns apps that match the search text

withVersion

boolean

Includes the latest compatible version in the response

Example

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

Response

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Update app

PATCH /rest/2/addons/{addonKey}

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.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Body parameters

data

[JsonPatchDocumentation]

Example

curl --request PATCH \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json-patch+json' \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}'

Response

204 No Content

Successfully modified

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Get app approval

GET /rest/2/addons/{addonKey}/approval

Get a specific app approval status.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Example

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

Response

404 Not Found

The resource does not exist or isn’t visible to you

Update app approval

PUT /rest/2/addons/{addonKey}/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.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Body parameters

ApprovalStatusLinks

reason

string

The reason why the app or app version was rejected

status

string

Indicates the status of the approval

Valid values:
  • pending
  • approved
  • rejected

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json' \
  --data '
    {
      "_links": {
        "issuePortal": {},
        "parent": {},
        "self": {
          "href": "string",
          "title": "string",
          "type": "string"
        }
      },
      "reason": "string",
      "status": "string"
    }' \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/approval'

Response

Invalid properties

Get app metrics

GET /rest/2/addons/{addonKey}/distribution

Get a summary of an app’s latest metrics.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Example

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

Response

404 Not Found

The resource does not exist or isn’t visible to you

Get app active installations

GET /rest/2/addons/{addonKey}/distribution/active

Get a specific app’s active installation counts over time.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution/active'

Response

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Get app active installations (by application)

GET /rest/2/addons/{addonKey}/distribution/application

Get a specific app’s active installation counts over time, aggregated by application.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution/application'

Response

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Get app active installations (by application version)

GET /rest/2/addons/{addonKey}/distribution/application/version

Get a specific app’s active installation counts over time, aggregated by application version.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution/application/version'

Response

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Get app active installations (by major application version)

GET /rest/2/addons/{addonKey}/distribution/application/version/major

Get a specific app’s active installation counts over time, aggregated by major application version.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution/application/version/major'

Response

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Get app active installations (by minor application version)

GET /rest/2/addons/{addonKey}/distribution/application/version/minor

Get a specific app’s active installation counts over time, aggregated by minor application version.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution/application/version/minor'

Response

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Get app active installations (by app version)

GET /rest/2/addons/{addonKey}/distribution/version

Get a specific app’s active installation counts over time, aggregated by app version.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution/version'

Response

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Get app feedback

GET /rest/2/addons/{addonKey}/feedbacks

Get a list of app feedback matching the specified parameters.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Query parameters

includeAnonymous

boolean

Include anonymous feedback

limit

integer

If specified, limits the result set to this number of items

offset

integer

If specified, skips ahead by this number of items

reason

string

Return feedback for the specified reason only

Valid values:
  • bugs
  • interface
  • functionality
  • usefulness
  • cost
  • reinstalling
  • reenabling
  • other

type

string

Return feedback for the specified feedback type only

Valid values:
  • disable
  • uninstall

Example

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

Response

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Get aggregated app feedback

GET /rest/2/addons/{addonKey}/feedbacks/distribution

Get aggregated feedback for the specified app, aggregated by the specified metric.

Feedback can be aggregated by type.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Query parameters

endDate

string

Ending date for the query

startDate

string

Starting date for the query

type REQUIRED

string

Restricts the feedback distribution to the specified feedback type

Valid values:
  • disable
  • uninstall

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/feedbacks/distribution?type=string(required)'

Response

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Get app pricing

GET /rest/2/addons/{addonKey}/pricing/{cloudOrServer}/{liveOrPending}

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.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

cloudOrServer REQUIRED

string

Valid values:
  • server
  • cloud

liveOrPending REQUIRED

string

Specifies either the pricing that is currently in effect and visible to users (live), or pending that will take effect after a delay

Valid values:
  • live
  • pending

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/pricing/{cloudOrServer}/{liveOrPending}'

Response

404 Not Found

The app is unknown or it does not have pricing of the specified type

Submit app pricing

PUT /rest/2/addons/{addonKey}/pricing/{cloudOrServer}/{liveOrPending}

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.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

cloudOrServer REQUIRED

string

Valid values:
  • server
  • cloud

liveOrPending REQUIRED

string

Specifies either the pricing that is currently in effect and visible to users (live), or pending that will take effect after a delay

Valid values:
  • live
  • pending

Body parameters

SelfLinkOnly

canChangePrices

boolean

True if it is possible to submit new pricing at this time

contactSalesForAdditionalPricing

boolean

True if the vendor can be contacted for additional pricing

default

boolean

True if this is predefined pricing from an application rather than app pricing

expertDiscountOptOut

boolean

True if Atlassian Experts cannot purchase the app at a discount

hasPublishedPrices

boolean

True if live pricing exists for the app

items

[PricingItem]

The non-free pricing tiers for the app

lastModified

string

Timestamp of the last change made to this pricing

parent

string

Key of the application that the app is for

perUnitItems

[PricingItem]

The per-unit pricing brackets for the app

role

AddonRole

status

string

Indicates whether this is pricing that is currently in effect and visible to users (live) or pending pricing that will take effect after a delay

Valid values:
  • live
  • pending

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json' \
  --data '
    {
      "_links": {
        "self": {}
      },
      "canChangePrices": true,
      "contactSalesForAdditionalPricing": true,
      "default": true,
      "expertDiscountOptOut": true,
      "hasPublishedPrices": true,
      "items": [
        {
          "amount": 123.456,
          "description": "string",
          "editionDescription": "string",
          "editionId": "string",
          "editionType": "string",
          "licenseType": "string",
          "monthsValid": 123456,
          "renewalAmount": 123.456,
          "unitCount": 123456
        }
      ],
      "lastModified": "string",
      "parent": "string",
      "perUnitItems": [
        {}
      ],
      "role": {
        "pluralName": "string",
        "singularName": "string"
      },
      "status": "string"
    }' \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/pricing/{cloudOrServer}/{liveOrPending}'

Response

Invalid properties

Get app recommendations

GET /rest/2/addons/{addonKey}/recommendations

Get apps recommended to users of the specified app.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Query parameters

application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

category

[string]

Only returns apps with any of the specified categories

cost

string

Only returns apps with the specified payment model

Valid values:
  • free
  • paid
  • marketplace
  • orderable

filter

string

Return apps filtered or sorted using the specified parameter

Valid values:
  • featured
  • highest-rated
  • recent
  • new
  • popular
  • top-grossing
  • trending
  • atlassian
  • codegeist
  • verified
  • name

forThisUser

boolean

Only returns apps from vendors associated with the current user

hosting

string

Only returns apps with the specified hosting model

Valid values:
  • cloud
  • server
  • datacenter
  • any

includeHidden

string

Includes apps that are normally hidden in the site

Valid values:
  • visibleInApp
  • all

includePrivate

boolean

Includes private apps or versions if you are authorized to see them

marketingLabel

[string]

Only returns apps with the specified marketing labels

text

string

Only returns apps that match the search text

withVersion

boolean

Includes the latest compatible version in the response

Example

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

Response

Get app release status

GET /rest/2/addons/{addonKey}/release

Get a specific app’s release status.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Example

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

Response

404 Not Found

The resource does not exist or isn’t visible to you

Release app

PUT /rest/2/addons/{addonKey}/release

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.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Body parameters

released

boolean

Whether the app has been released

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json' \
  --data '
    {
      "released": true
    }' \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/release'

Response

Invalid properties

Get app reviews

GET /rest/2/addons/{addonKey}/reviews

Get a list of reviews for the specified app.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Query parameters

limit

integer

If specified, limits the result set to this number of items

offset

integer

If specified, skips ahead by this number of items

sort

string

Specifies the review sort order

Valid values:
  • recent
  • helpful

Example

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

Response

Create / update app review

POST /rest/2/addons/{addonKey}/reviews

Create or update a specific app review.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Body parameters

_embedded

ReviewEmbedded

ReviewLinks

date

string

The date when the app was reviewed

helpfulVotes

integer

Number of helpful votes

hosting

string

The review hosting type, either cloud or server

Valid values:
  • cloud
  • server

review

string

App review content

stars

integer

Number of stars

totalVotes

integer

Total number of votes

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json' \
  --data '
    {
      "_embedded": {
        "author": {
          "_links": {
            "alternate": {},
            "picture": {},
            "pictureTemplate": {
              "name": "string",
              "template": "string",
              "type": "string"
            }
          },
          "email": "string",
          "name": "string"
        },
        "response": {
          "_links": {
            "self": {}
          },
          "text": "string"
        }
      },
      "_links": {
        "alternate": {},
        "author": {},
        "flag": {},
        "response": {},
        "self": {
          "href": "string",
          "title": "string",
          "type": "string"
        },
        "voteDown": {},
        "voteUp": {}
      },
      "date": "string",
      "helpfulVotes": 123456,
      "hosting": "string",
      "review": "string",
      "stars": 123456,
      "totalVotes": 123456
    }' \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews'

Response

204 No Content

Successfully modified

Get app review

GET /rest/2/addons/{addonKey}/reviews/id/{reviewId}

Get a specific app review.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

reviewId REQUIRED

string

Example

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

Response

404 Not Found

The resource does not exist or isn’t visible to you

Create / update app review

PUT /rest/2/addons/{addonKey}/reviews/id/{reviewId}

Create or update a specific app review.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

reviewId REQUIRED

string

Body parameters

_embedded

object

object

date

string

The date when the app was reviewed

helpfulVotes

integer

Number of helpful votes

hosting

string

The review hosting type, either cloud or server

Valid values:
  • cloud
  • server

review

string

App review content

stars

integer

Number of stars

totalVotes

integer

Total number of votes

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json' \
  --data '
    {
      "_embedded": {
        "author": {
          "_links": {
            "alternate": {},
            "picture": {},
            "pictureTemplate": {
              "name": "string",
              "template": "string",
              "type": "string"
            }
          },
          "email": "string",
          "name": "string"
        },
        "response": {
          "_links": {
            "self": {}
          },
          "text": "string"
        }
      },
      "_links": {
        "alternate": {},
        "author": {},
        "flag": {},
        "response": {},
        "self": {
          "href": "string",
          "title": "string",
          "type": "string"
        },
        "voteDown": {},
        "voteUp": {}
      },
      "date": "string",
      "helpfulVotes": 123456,
      "hosting": "string",
      "review": "string",
      "stars": 123456,
      "totalVotes": 123456
    }' \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}'

Response

204 No Content

Successfully modified

404 Not Found

The resource does not exist or isn’t visible to you

Delete app review

DELETE /rest/2/addons/{addonKey}/reviews/id/{reviewId}

Delete a specific app review.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

reviewId REQUIRED

string

Example

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

Response

204 No Content

Success

404 Not Found

The resource does not exist or isn’t visible to you

Get app review downvote

GET /rest/2/addons/{addonKey}/reviews/id/{reviewId}/down

Returns whether or not the current user has downvoted the specified app review.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

reviewId REQUIRED

string

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/down'

Response

404 Not Found

The resource does not exist or isn’t visible to you

Update app review downvote

PUT /rest/2/addons/{addonKey}/reviews/id/{reviewId}/down

Updates whether or not the current user has downvoted the specified app review.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

reviewId REQUIRED

string

Body parameters

BooleanStateRepLinks

state

boolean

The true/false value of the state - its meaning depends on the resource

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json' \
  --data '
    {
      "_links": {
        "self": {
          "href": "string",
          "title": "string",
          "type": "string"
        },
        "up": {}
      },
      "state": true
    }' \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/down'

Response

204 No Content

Successfully modified

Get app review flag

GET /rest/2/addons/{addonKey}/reviews/id/{reviewId}/flag

Returns whether or not the current user has flagged the specified app review.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

reviewId REQUIRED

string

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/flag'

Response

404 Not Found

The resource does not exist or isn’t visible to you

Update app review flag

PUT /rest/2/addons/{addonKey}/reviews/id/{reviewId}/flag

Updates whether or not the current user has flagged the specified app review.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

reviewId REQUIRED

string

Body parameters

object

state

boolean

The true/false value of the state - its meaning depends on the resource

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json' \
  --data '
    {
      "_links": {
        "self": {
          "href": "string",
          "title": "string",
          "type": "string"
        },
        "up": {}
      },
      "state": true
    }' \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/flag'

Response

204 No Content

Successfully modified

Get app review response

GET /rest/2/addons/{addonKey}/reviews/id/{reviewId}/response

Get the response for the specified app review.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

reviewId REQUIRED

string

Example

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

Response

404 Not Found

The resource does not exist or isn’t visible to you

Create / update app review response

PUT /rest/2/addons/{addonKey}/reviews/id/{reviewId}/response

Create or update a specific app review response.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

reviewId REQUIRED

string

Body parameters

object

text

string

Text of the response to the review

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json' \
  --data '
    {
      "_links": {
        "self": {}
      },
      "text": "string"
    }' \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/response'

Response

204 No Content

Successfully modified

404 Not Found

The resource does not exist or isn’t visible to you

Delete app review response

DELETE /rest/2/addons/{addonKey}/reviews/id/{reviewId}/response

Delete a specific app review response.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

reviewId REQUIRED

string

Example

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

Response

204 No Content

Success

404 Not Found

The resource does not exist or isn’t visible to you

Get app review upvote

GET /rest/2/addons/{addonKey}/reviews/id/{reviewId}/up

Returns whether or not the current user has upvoted the specified app review.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

reviewId REQUIRED

string

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/up'

Response

404 Not Found

The resource does not exist or isn’t visible to you

Update app review upvote

PUT /rest/2/addons/{addonKey}/reviews/id/{reviewId}/up

Updates whether or not the current user has upvoted the specified app review.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

reviewId REQUIRED

string

Body parameters

object

state

boolean

The true/false value of the state - its meaning depends on the resource

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json' \
  --data '
    {
      "_links": {
        "self": {
          "href": "string",
          "title": "string",
          "type": "string"
        },
        "up": {}
      },
      "state": true
    }' \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/up'

Response

204 No Content

Successfully modified

Get my app review

GET /rest/2/addons/{addonKey}/reviews/mine

Get a specific app review written by the current user.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/mine'

Response

404 Not Found

The resource does not exist or isn’t visible to you

Create / update my app review

PUT /rest/2/addons/{addonKey}/reviews/mine

Create or update a specific app review written by the current user.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Body parameters

_embedded

object

object

date

string

The date when the app was reviewed

helpfulVotes

integer

Number of helpful votes

hosting

string

The review hosting type, either cloud or server

Valid values:
  • cloud
  • server

review

string

App review content

stars

integer

Number of stars

totalVotes

integer

Total number of votes

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json' \
  --data '
    {
      "_embedded": {
        "author": {
          "_links": {
            "alternate": {},
            "picture": {},
            "pictureTemplate": {
              "name": "string",
              "template": "string",
              "type": "string"
            }
          },
          "email": "string",
          "name": "string"
        },
        "response": {
          "_links": {
            "self": {}
          },
          "text": "string"
        }
      },
      "_links": {
        "alternate": {},
        "author": {},
        "flag": {},
        "response": {},
        "self": {
          "href": "string",
          "title": "string",
          "type": "string"
        },
        "voteDown": {},
        "voteUp": {}
      },
      "date": "string",
      "helpfulVotes": 123456,
      "hosting": "string",
      "review": "string",
      "stars": 123456,
      "totalVotes": 123456
    }' \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/mine'

Response

204 No Content

Successfully modified

404 Not Found

The resource does not exist or isn’t visible to you

Delete my app review

DELETE /rest/2/addons/{addonKey}/reviews/mine

Delete a specific app review written by the current user.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/mine'

Response

204 No Content

Success

404 Not Found

The resource does not exist or isn’t visible to you

Get access tokens

GET /rest/2/addons/{addonKey}/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.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Example

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

Response

404 Not Found

The resource does not exist or isn’t visible to you

Create access token

POST /rest/2/addons/{addonKey}/tokens

Create a new access token.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Example

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

Response

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

409 Conflict

The app already has the maximum number of tokens

Get access token

GET /rest/2/addons/{addonKey}/tokens/{token}

Get a specific access token.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

token REQUIRED

string

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/tokens/{token}'

Response

404 Not Found

The resource does not exist or isn’t visible to you

Validate access token

POST /rest/2/addons/{addonKey}/tokens/{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.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

token REQUIRED

string

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/tokens/{token}'

Response

204 No Content

Success

Invalid properties

403 Forbidden

The request’s Origin header does not match the access token’s host

404 Not Found

The resource does not exist or isn’t visible to you

Delete access token

DELETE /rest/2/addons/{addonKey}/tokens/{token}

Delete a specific access token.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

token REQUIRED

string

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/tokens/{token}'

Response

204 No Content

Success

404 Not Found

The resource does not exist or isn’t visible to you

Get app versions

GET /rest/2/addons/{addonKey}/versions

Get a list of versions for the specified app.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Query parameters

afterVersion

string

Selects only app versions newer than the version with the specified display name

application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

cost

string

Only returns apps with the specified payment model

Valid values:
  • free
  • paid
  • marketplace
  • orderable

hosting

string

Only returns apps with the specified hosting model

Valid values:
  • cloud
  • server
  • datacenter
  • any

includePrivate

boolean

Includes private apps or versions if you are authorized to see them

limit

integer

If specified, limits the result set to this number of items

offset

integer

If specified, skips ahead by this number of items

Example

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

Response

Create app version

POST /rest/2/addons/{addonKey}/versions

Create a new version for the specified app.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Body parameters

_embedded

object

object

buildNumber

integer

The unique internal identifier and sort key for this version; omit this if you are creating an Atlassian Connect version

compatibilities

[object]

Describes the application(s), version ranges, and hosting models the app version is compatible with; you may omit this when creating a version and Marketplace will use the previous version’s compatibilities

deployable

boolean

True if this app version is directly installable

deployment REQUIRED

object

integrationType

string

Integration type if the app is a Hipchat integration

Valid values:
  • room
  • global
  • informational

legacy REQUIRED

object

name

string

The display name of the version, for example “1.0.0”

paymentModel

string

The payment model; you may omit this when creating a version and Marketplace will infer it, unless it is paid via vendor

Valid values:
  • free
  • vendor
  • atlassian

release REQUIRED

object

static

boolean

True if this is a static app (Plugins 1, a deprecated app framework)

status

string

Indicates whether the version is public, private, or pending approval

Valid values:
  • private
  • public
  • submitted
  • rejected

text

object

object

youtubeId

string

YouTube video identifier if the version’s hero image is a video

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json' \
  --data '
    {
      "_embedded": {
        "artifact": {
          "_links": {
            "binary": {},
            "remote": {},
            "self": {}
          }
        },
        "functionalCategories": [
          {}
        ],
        "hero": {},
        "highlights": [
          {
            "_embedded": {
              "screenshot": {},
              "thumbnail": {}
            },
            "_links": {
              "screenshot": {},
              "thumbnail": {}
            },
            "body": "string",
            "explanation": "string",
            "title": "string"
          }
        ],
        "instructions": [
          {
            "_embedded": {
              "image": {}
            },
            "_links": {
              "image": {}
            },
            "body": "string"
          }
        ],
        "license": {
          "_links": {
            "alternate": {},
            "self": {}
          },
          "key": "string",
          "name": "string"
        },
        "screenshots": [
          {
            "_embedded": {
              "image": {}
            },
            "_links": {
              "image": {}
            },
            "caption": "string"
          }
        ]
      },
      "_links": {
        "agreement": {},
        "alternate": {},
        "approval": {},
        "artifact": {},
        "edit": {},
        "functionalCategories": [
          {}
        ],
        "hero": {},
        "license": {},
        "self": {},
        "transition": {}
      },
      "buildNumber": 123456,
      "compatibilities": [
        {
          "application": "string",
          "hosting": {
            "cloud": true,
            "server": {
              "max": {},
              "min": {
                "build": 123456,
                "version": "string"
              }
            }
          }
        }
      ],
      "deployable": true,
      "deployment": {
        "autoUpdateAllowed": true,
        "cloud": true,
        "connect": true,
        "dataCenter": true,
        "permissions": [
          {
            "_links": {
              "alternate": {}
            },
            "description": "string",
            "key": "string",
            "name": "string"
          }
        ],
        "server": true
      },
      "integrationType": "string",
      "legacy": {
        "vendorLinks": {
          "donate": "string",
          "evaluationLicense": "string",
          "javadocs": "string",
          "releaseNotes": "string",
          "source": "string"
        }
      },
      "name": "string",
      "paymentModel": "string",
      "release": {
        "beta": true,
        "date": "string",
        "releasedBy": "string",
        "supported": true
      },
      "static": true,
      "status": "string",
      "text": {
        "moreDetails": "string",
        "releaseNotes": "string",
        "releaseSummary": "string"
      },
      "vendorLinks": {
        "binary": "string",
        "documentation": "string",
        "eula": "string",
        "learnMore": "string",
        "license": "string",
        "purchase": "string",
        "releaseNotes": "string"
      },
      "youtubeId": "string"
    }' \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/versions'

Response

201 Created

Successfully created

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Get app version (by number)

GET /rest/2/addons/{addonKey}/versions/build/{pluginBuildNumber}

Get the latest version of the specified app.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

pluginBuildNumber REQUIRED

integer

The unique internal identifier and sort key for this version

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/versions/build/{pluginBuildNumber}'

Response

404 Not Found

The resource does not exist or isn’t visible to you

Update app version

PATCH /rest/2/addons/{addonKey}/versions/build/{pluginBuildNumber}

Update a specific version for the specified 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.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

pluginBuildNumber REQUIRED

integer

The unique internal identifier and sort key for this version

Body parameters

data

[JsonPatchDocumentation]

Example

curl --request PATCH \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json-patch+json' \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/versions/build/{pluginBuildNumber}'

Response

204 No Content

Successfully modified

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Get app version approval

GET /rest/2/addons/{addonKey}/versions/build/{pluginBuildNumber}/approval

Get a specific app version approval status.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

pluginBuildNumber REQUIRED

integer

The unique internal identifier and sort key for this version

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/versions/build/{pluginBuildNumber}/approval'

Response

404 Not Found

The resource does not exist or isn’t visible to you

Update app version approval

PUT /rest/2/addons/{addonKey}/versions/build/{pluginBuildNumber}/approval

Approve, reject or resubmit an app version for approval.

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

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

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

pluginBuildNumber REQUIRED

integer

The unique internal identifier and sort key for this version

Body parameters

object

reason

string

The reason why the app or app version was rejected

status

string

Indicates the status of the approval

Valid values:
  • pending
  • approved
  • rejected

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json' \
  --data '
    {
      "_links": {
        "issuePortal": {},
        "parent": {},
        "self": {
          "href": "string",
          "title": "string",
          "type": "string"
        }
      },
      "reason": "string",
      "status": "string"
    }' \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/versions/build/{pluginBuildNumber}/approval'

Response

204 No Content

Success

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Get app version (latest)

GET /rest/2/addons/{addonKey}/versions/latest

Get the latest version of the specified app.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Query parameters

afterVersion

string

Selects only app versions newer than the version with the specified display name

application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

cost

string

Only returns apps with the specified payment model

Valid values:
  • free
  • paid
  • marketplace
  • orderable

hosting

string

Only returns apps with the specified hosting model

Valid values:
  • cloud
  • server
  • datacenter
  • any

includePrivate

boolean

Includes private apps or versions if you are authorized to see them

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/versions/latest'

Response

404 Not Found

The resource does not exist or isn’t visible to you

Get app version (by name)

GET /rest/2/addons/{addonKey}/versions/name/{name}

Get details about a specific version, matching the specified name, of the specified app.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

name REQUIRED

string

The display name of the version, for example “1.0.0”

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/versions/name/{name}'

Response

404 Not Found

The resource does not exist or isn’t visible to you

Get watch/unwatch app state

GET /rest/2/addons/{addonKey}/watch

Returns whether or not the current user is watching the specified app.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Example

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

Response

Watch / unwatch app

PUT /rest/2/addons/{addonKey}/watch

Updates whether or not the current user is watching the specified app.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

addonKey REQUIRED

string

The unique identifier for this app, for example “com.atlassian.confluence.plugins.confluence-questions”

Body parameters

object

state

boolean

The true/false value of the state - its meaning depends on the resource

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json' \
  --data '
    {
      "_links": {
        "self": {
          "href": "string",
          "title": "string",
          "type": "string"
        },
        "up": {}
      },
      "state": true
    }' \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/watch'

Response

204 No Content

Successfully modified

Get archived apps

GET /rest/2/addons/archived

Get a list of archived apps matching the specified parameters.

Response content type: application/json

Request

Query parameters

application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

category

[string]

Only returns apps with any of the specified categories

cost

string

Only returns apps with the specified payment model

Valid values:
  • free
  • paid
  • marketplace
  • orderable

filter

string

Return apps filtered or sorted using the specified parameter

Valid values:
  • featured
  • highest-rated
  • recent
  • new
  • popular
  • top-grossing
  • trending
  • atlassian
  • codegeist
  • verified
  • name

forThisUser

boolean

Only returns apps from vendors associated with the current user

hosting

string

Only returns apps with the specified hosting model

Valid values:
  • cloud
  • server
  • datacenter
  • any

includeHidden

string

Includes apps that are normally hidden in the site

Valid values:
  • visibleInApp
  • all

includePrivate

boolean

Includes private apps or versions if you are authorized to see them

limit

integer

If specified, limits the result set to this number of items

marketingLabel

[string]

Only returns apps with the specified marketing labels

offset

integer

If specified, skips ahead by this number of items

text

string

Only returns apps that match the search text

withVersion

boolean

Includes the latest compatible version in the response

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/archived'

Response

Get archived apps (by vendor)

GET /rest/2/addons/archived/vendor/{vendorId}

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

Response content type: application/json

Request

Path parameters

vendorId REQUIRED

integer

The unique identifier for this vendor

Query parameters

application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

category

[string]

Only returns apps with any of the specified categories

cost

string

Only returns apps with the specified payment model

Valid values:
  • free
  • paid
  • marketplace
  • orderable

filter

string

Return apps filtered or sorted using the specified parameter

Valid values:
  • featured
  • highest-rated
  • recent
  • new
  • popular
  • top-grossing
  • trending
  • atlassian
  • codegeist
  • verified
  • name

forThisUser

boolean

Only returns apps from vendors associated with the current user

hosting

string

Only returns apps with the specified hosting model

Valid values:
  • cloud
  • server
  • datacenter
  • any

includeHidden

string

Includes apps that are normally hidden in the site

Valid values:
  • visibleInApp
  • all

includePrivate

boolean

Includes private apps or versions if you are authorized to see them

limit

integer

If specified, limits the result set to this number of items

marketingLabel

[string]

Only returns apps with the specified marketing labels

offset

integer

If specified, skips ahead by this number of items

text

string

Only returns apps that match the search text

withVersion

boolean

Includes the latest compatible version in the response

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/archived/vendor/{vendorId}'

Response

Get app banners

GET /rest/2/addons/listings/banners

Get a list of app banners matching the specified parameters.

Response content type: application/json

Request

Query parameters

application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

category

[string]

Only returns apps with any of the specified categories

cost

string

Only returns apps with the specified payment model

Valid values:
  • free
  • paid
  • marketplace
  • orderable

filter

string

Return apps filtered or sorted using the specified parameter

Valid values:
  • featured
  • highest-rated
  • recent
  • new
  • popular
  • top-grossing
  • trending
  • atlassian
  • codegeist
  • verified
  • name

forThisUser

boolean

Only returns apps from vendors associated with the current user

hosting

string

Only returns apps with the specified hosting model

Valid values:
  • cloud
  • server
  • datacenter
  • any

includeHidden

string

Includes apps that are normally hidden in the site

Valid values:
  • visibleInApp
  • all

includePrivate

boolean

Includes private apps or versions if you are authorized to see them

limit

integer

If specified, limits the result set to this number of items

marketingLabel

[string]

Only returns apps with the specified marketing labels

offset

integer

If specified, skips ahead by this number of items

text

string

Only returns apps that match the search text

withVersion

boolean

Includes the latest compatible version in the response

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/listings/banners'

Response

Get apps (brief)

GET /rest/2/addons/search/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.

Response content type: application/json

Request

Query parameters

q

string

Text to search for

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/search/brief'

Response

Get apps (by vendor)

GET /rest/2/addons/vendor/{vendorId}

Get a list of apps for the specified vendor.

Response content type: application/json

Request

Path parameters

vendorId REQUIRED

integer

The unique identifier for this vendor

Query parameters

application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

category

[string]

Only returns apps with any of the specified categories

cost

string

Only returns apps with the specified payment model

Valid values:
  • free
  • paid
  • marketplace
  • orderable

filter

string

Return apps filtered or sorted using the specified parameter

Valid values:
  • featured
  • highest-rated
  • recent
  • new
  • popular
  • top-grossing
  • trending
  • atlassian
  • codegeist
  • verified
  • name

forThisUser

boolean

Only returns apps from vendors associated with the current user

hosting

string

Only returns apps with the specified hosting model

Valid values:
  • cloud
  • server
  • datacenter
  • any

includeHidden

string

Includes apps that are normally hidden in the site

Valid values:
  • visibleInApp
  • all

includePrivate

boolean

Includes private apps or versions if you are authorized to see them

limit

integer

If specified, limits the result set to this number of items

marketingLabel

[string]

Only returns apps with the specified marketing labels

offset

integer

If specified, skips ahead by this number of items

text

string

Only returns apps that match the search text

withVersion

boolean

Includes the latest compatible version in the response

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/addons/vendor/{vendorId}'

Response

Applications

Get applications

GET /rest/2/applications

Get a list of applications.

Response content type: application/json

Request

Query parameters

limit

integer

If specified, limits the result set to this number of items

offset

integer

If specified, skips ahead by this number of items

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/applications'

Response

Get application

GET /rest/2/applications/{applicationKey}

Get a specific application.

Response content type: application/json

Request

Path parameters

applicationKey REQUIRED

string

The unique identifier for this application, for example “jira”

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/applications/{applicationKey}'

Response

404 Not Found

The resource does not exist or isn’t visible to you

Get application versions

GET /rest/2/applications/{applicationKey}/versions

Get a list of versions for the specified application.

Response content type: application/json

Request

Path parameters

applicationKey REQUIRED

string

The unique identifier for this application, for example “jira”

Query parameters

afterBuildNumber

integer

Selects only application versions whose build number is greater than this

limit

integer

If specified, limits the result set to this number of items

offset

integer

If specified, skips ahead by this number of items

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/applications/{applicationKey}/versions'

Response

404 Not Found

The resource does not exist or isn’t visible to you

Get application version (by number)

GET /rest/2/applications/{applicationKey}/versions/build/{applicationBuildNumber}

Get details about a specific version, matching the specified build number, of the specified application.

Response content type: application/json

Request

Path parameters

applicationBuildNumber REQUIRED

integer

The unique integer identifier for the application version

applicationKey REQUIRED

string

The unique identifier for this application, for example “jira”

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/applications/{applicationKey}/versions/build/{applicationBuildNumber}'

Response

404 Not Found

The resource does not exist or isn’t visible to you

Get application version (latest)

GET /rest/2/applications/{applicationKey}/versions/latest

Get the latest version of the specified application.

Response content type: application/json

Request

Path parameters

applicationKey REQUIRED

string

The unique identifier for this application, for example “jira”

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/applications/{applicationKey}/versions/latest'

Response

404 Not Found

The resource does not exist or isn’t visible to you

Get application version (by name)

GET /rest/2/applications/{applicationKey}/versions/name/{name}

Get details about a specific version, matching the specified name, of the specified application.

Response content type: application/json

Request

Path parameters

applicationKey REQUIRED

string

The unique identifier for this application, for example “jira”

name REQUIRED

string

The display name of the version, for example “1.0.0”

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/applications/{applicationKey}/versions/name/{name}'

Response

404 Not Found

The resource does not exist or isn’t visible to you

Assets

Get asset links

GET /rest/2/assets

Get links to permitted asset resources.

Response content type: application/json

Request

There are no parameters for this request.

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/assets'

Response

Get asset details

GET /rest/2/assets/{assetName}

Returns details about a previously uploaded file that Marketplace is now storing.

The asset can either be an image file or an app artifact. If it is an app artifact, the response may include additional properties which are used internally and should be ignored.

Response content type: application/json

Request

Path parameters

assetName REQUIRED

string

The unique identifying string that Marketplace uses to refer to this asset

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/assets/{assetName}'

Response

Delete asset

DELETE /rest/2/assets/{assetName}

Removes a file from Marketplace storage which had been previously uploaded.

This is only allowed if:

  1. you, rather than another user, uploaded the file, and
  2. the asset is not currently being used by any other resource (for example, it cannot be the logo image for an existing app).

This resource requires authentication.

Response content type: application/json

Request

Path parameters

assetName REQUIRED

string

The unique identifying string that Marketplace uses to refer to this asset

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/assets/{assetName}'

Response

204 No Content

Success

Upload app artifact

POST /rest/2/assets/artifact

Use this resource to upload an app artifact (.jar or .obr) to Marketplace, so it can be used by an app version.

The request body is the file data.

If successful, the resource will respond with a resource link in _links.self that can be used as the artifact link when creating an app or app version. The response may include additional properties; other than fileInfo, these are used internally and should be ignored.

This resource requires authentication.

Response content type: application/json

Request

Query parameters

file REQUIRED

string

The logical filename

Body parameters

data

string

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json' \
  --data '
    "string"' \
  --url 'https://marketplace.atlassian.com/rest/2/assets/artifact?file=string(required)'

Response

Invalid properties

Validate app artifact

POST /rest/2/assets/artifact/fetch

Use this resource to copy and validate an app artifact (.jar or .obr) that is available from an external URL, so it can be used by an app version.

If successful, you will get a resource link in _links.self that can be used as the artifact link when creating an app or app version.

Note that this step can be skipped by just setting the artifact link to the external URL where the artifact is hosted when creating an app version; Marketplace will then download the artifact automatically.

This resource requires authentication.

Response content type: application/json

Request

Query parameters

uri REQUIRED

string

Marketplace will attempt to download the artifact from this location

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/assets/artifact/fetch?uri=string(required)'

Response

Invalid properties

Upload image

POST /rest/2/assets/image/{imageType}

Use this resource to upload an image (.jpg, .png, .gif, .bmp) to Marketplace, so you can use it for an app or vendor.

The request body is the file data.

If successful, you will get a resource link in _links.self that you can use as the appropriate image link in another resource, for example the logo link if you are creating an app.

Note that if the image is available from an external URL, you can skip this step by just setting the image link tothat external URL when you are creating the resource that uses it.

Response content type: application/json

Request

Path parameters

imageType REQUIRED

string

Specifies what this image will be used for, which determines the allowable image size

Valid values:
  • logo
  • icon
  • banner
  • screenshot
  • screenshot-thumbnail
  • title-logo
  • hero

Query parameters

file REQUIRED

string

The logical filename

Body parameters

data

string

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json' \
  --data '
    "string"' \
  --url 'https://marketplace.atlassian.com/rest/2/assets/image/{imageType}?file=string(required)'

Response

Invalid properties

LicenseTypes

Get license types

GET /rest/2/licenseTypes

Get a list of license types.

Response content type: application/json

Request

There are no parameters for this request.

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/licenseTypes'

Response

Get license type

GET /rest/2/licenseTypes/{licenseTypeKey}

Get a specific license type.

Response content type: application/json

Request

Path parameters

licenseTypeKey REQUIRED

string

The unique identifier for this license type, for example “gpl”

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/licenseTypes/{licenseTypeKey}'

Response

404 Not Found

The resource does not exist or isn’t visible to you

Products

Get products

GET /rest/2/products

Get a list of products matching the specified parameters.

Response content type: application/json

Request

Query parameters

application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

cost

string

Only returns apps with the specified payment model

Valid values:
  • free
  • paid
  • marketplace
  • orderable

hosting

string

Only returns apps with the specified hosting model

Valid values:
  • cloud
  • server
  • datacenter
  • any

limit

integer

If specified, limits the result set to this number of items

offset

integer

If specified, skips ahead by this number of items

withVersion

boolean

Includes the latest compatible version in the response

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/products'

Response

Invalid properties

Get product

GET /rest/2/products/key/{productKey}

Get a specific product.

Response content type: application/json

Request

Path parameters

productKey REQUIRED

string

The unique identifier for this product, for example “jira-software”

Query parameters

application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

cost

string

Only returns apps with the specified payment model

Valid values:
  • free
  • paid
  • marketplace
  • orderable

hosting

string

Only returns apps with the specified hosting model

Valid values:
  • cloud
  • server
  • datacenter
  • any

withVersion

boolean

Includes the latest compatible version in the response

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/products/key/{productKey}'

Response

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Get product versions

GET /rest/2/products/key/{productKey}/versions

Get a list of versions for the specified product.

Response content type: application/json

Request

Path parameters

productKey REQUIRED

string

The unique identifier for this product, for example “jira-software”

Query parameters

application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

cost

string

Only returns apps with the specified payment model

Valid values:
  • free
  • paid
  • marketplace
  • orderable

hosting

string

Only returns apps with the specified hosting model

Valid values:
  • cloud
  • server
  • datacenter
  • any

limit

integer

If specified, limits the result set to this number of items

offset

integer

If specified, skips ahead by this number of items

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/products/key/{productKey}/versions'

Response

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Get product version (by number)

GET /rest/2/products/key/{productKey}/versions/build/{buildNumber}

Get details about a specific version, matching the specified build number, of the specified product.

Response content type: application/json

Request

Path parameters

buildNumber REQUIRED

integer

The unique internal identifier and sort key for this version

productKey REQUIRED

string

The unique identifier for this product, for example “jira-software”

Query parameters

application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

cost

string

Only returns apps with the specified payment model

Valid values:
  • free
  • paid
  • marketplace
  • orderable

hosting

string

Only returns apps with the specified hosting model

Valid values:
  • cloud
  • server
  • datacenter
  • any

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/products/key/{productKey}/versions/build/{buildNumber}'

Response

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Get product version (latest)

GET /rest/2/products/key/{productKey}/versions/latest

Get the latest version of the specified product.

Response content type: application/json

Request

Path parameters

productKey REQUIRED

string

The unique identifier for this product, for example “jira-software”

Query parameters

application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

cost

string

Only returns apps with the specified payment model

Valid values:
  • free
  • paid
  • marketplace
  • orderable

hosting

string

Only returns apps with the specified hosting model

Valid values:
  • cloud
  • server
  • datacenter
  • any

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/products/key/{productKey}/versions/latest'

Response

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Get product version (by name)

GET /rest/2/products/key/{productKey}/versions/name/{versionName}

Get details about a specific version, matching the specified name, of the specified product.

Response content type: application/json

Request

Path parameters

productKey REQUIRED

string

The unique identifier for this product, for example “jira-software”

versionName REQUIRED

string

The display name of the version, for example “1.0.0”

Query parameters

application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

cost

string

Only returns apps with the specified payment model

Valid values:
  • free
  • paid
  • marketplace
  • orderable

hosting

string

Only returns apps with the specified hosting model

Valid values:
  • cloud
  • server
  • datacenter
  • any

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/products/key/{productKey}/versions/name/{versionName}'

Response

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Vendors

Get vendors

GET /rest/2/vendors

Get a list of vendors matching the specified parameters.

Response content type: application/json

Request

Query parameters

excludeAtlassian

boolean

Exclude vendors associated with Atlassian

forThisUser

boolean

Only returns vendors associated with the current user

limit

integer

If specified, limits the result set to this number of items

offset

integer

If specified, skips ahead by this number of items

text

string

Only returns vendors with names that matches the search text

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors'

Response

Create vendor

POST /rest/2/vendors

Create a new vendor.

This resource requires authentication.

Response content type: application/json

Request

Body parameters

_embedded

VendorEmbedded

VendorLinks

address

Address

cloudSecurity

VendorCloudSecurity

description

string

Short introductory text that will appear on the vendor’s Marketplace page

email

string

The vendor’s public contact email

isAtlassian

boolean

Whether this vendor is one of the Atlassian vendors

name

string

Name of the vendor

otherContactDetails

string

Any other public contact information the vendor wishes to provide

phone

string

The vendor’s public phone number

solutionPartner

VendorSolutionPartner

supportDetails

VendorSupportDetails

VendorExternalLinks

verifiedStatus

string

Indicates whether the vendor has Atlassian Verified status

Valid values:
  • not-requested
  • requested
  • verified
  • needs-verification
  • flagged
  • rejected

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json' \
  --data '
    {
      "_embedded": {
        "logo": {
          "_links": {
            "highRes": {},
            "image": {},
            "self": {},
            "smallHighResImage": {},
            "smallImage": {},
            "unscaled": {}
          }
        }
      },
      "_links": {
        "addons": {},
        "alternate": {},
        "archivedAddons": {},
        "contacts": {},
        "edit": {},
        "licenseReport": {},
        "logo": {},
        "paymentInfo": {},
        "promotions": {},
        "reporting": {},
        "sales": {},
        "salesReport": {},
        "self": {
          "href": "string",
          "title": "string",
          "type": "string"
        }
      },
      "address": {
        "city": "string",
        "country": "string",
        "line1": "string",
        "line2": "string",
        "postCode": "string",
        "state": "string"
      },
      "cloudSecurity": {
        "approvalDate": "string",
        "approved": true,
        "expiryDate": "string",
        "issueKey": "string"
      },
      "description": "string",
      "email": "string",
      "isAtlassian": true,
      "name": "string",
      "otherContactDetails": "string",
      "phone": "string",
      "solutionPartner": {
        "partnerLevel": "string"
      },
      "supportDetails": {
        "emergencyContact": "string",
        "supportHours": {
          "days": [
            "string"
          ],
          "holidays": [
            {
              "date": "string",
              "repeatAnnually": true,
              "title": "string"
            }
          ],
          "range": {
            "from": "string",
            "until": "string"
          },
          "timezone": "string"
        },
        "supportOrg": {
          "name": "string",
          "supportEmail": "string",
          "supportPhone": "string",
          "supportUrl": "string"
        },
        "targetResponseTime": 123456
      },
      "vendorLinks": {
        "homePage": "string",
        "sla": "string"
      },
      "verifiedStatus": "string"
    }' \
  --url 'https://marketplace.atlassian.com/rest/2/vendors'

Response

201 Created

Successfully created

Get vendor

GET /rest/2/vendors/{vendorId}

Get a specific vendor.

Response content type: application/json

Request

Path parameters

vendorId REQUIRED

integer

The unique identifier for this vendor

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}'

Response

404 Not Found

The resource does not exist or isn’t visible to you

Update vendor

PATCH /rest/2/vendors/{vendorId}

Update a specific vendor.

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.

Response content type: application/json

Request

Path parameters

vendorId REQUIRED

integer

The unique identifier for this vendor

Body parameters

data

[JsonPatchDocumentation]

Example

curl --request PATCH \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json-patch+json' \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}'

Response

204 No Content

Successfully modified

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Get vendor contacts

GET /rest/2/vendors/{vendorId}/contacts

Get a list of contacts for the specified vendor.

Response content type: application/json

Request

Path parameters

vendorId REQUIRED

integer

The unique identifier for this vendor

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/contacts'

Response

Add vendor contact

POST /rest/2/vendors/{vendorId}/contacts

Adds a user as a contact associated with a specific vendor. The username property in the request body must match a user who already has an account on Marketplace.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

vendorId REQUIRED

integer

The unique identifier for this vendor

Body parameters

VendorContactLinks

displayName

string

The user’s full name

email

string

The user’s email. The email is only visible to the vendor and administrators

permissions

[string]

The user’s permissions. The permissions are only visible to the vendor administrators

username

string

The user’s Atlassian account username. The username is only visible to the vendor and administrators

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json' \
  --data '
    {
      "_links": {
        "alternate": {},
        "self": {
          "href": "string",
          "title": "string",
          "type": "string"
        }
      },
      "displayName": "string",
      "email": "string",
      "permissions": [
        "string"
      ],
      "username": "string"
    }' \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/contacts'

Response

201 Created

Successfully created

409 Conflict

The user is already a contact for the vendor

Get vendor contact

GET /rest/2/vendors/{vendorId}/contacts/{userId}

Get a specific contact for the specified vendor.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

userId REQUIRED

integer

vendorId REQUIRED

integer

The unique identifier for this vendor

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/contacts/{userId}'

Response

Update vendor contact

PATCH /rest/2/vendors/{vendorId}/contacts/{userId}

Updates the permissions a particular user has in association with a particular vendor.

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.

Response content type: application/json

Request

Path parameters

userId REQUIRED

integer

vendorId REQUIRED

integer

The unique identifier for this vendor

Body parameters

data

[JsonPatchDocumentation]

Example

curl --request PATCH \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json-patch+json' \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/contacts/{userId}'

Response

204 No Content

Successfully modified

304 Not Modified

No update was performed because the user is already assigned the given set of permissions.

403 Forbidden

Not allowed because you are changing your permissions.

Delete vendor contact

DELETE /rest/2/vendors/{vendorId}/contacts/{userId}

Removes the user from the vendor’s list of contacts. This resource does not remove the user’s Marketplace account.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

userId REQUIRED

integer

vendorId REQUIRED

integer

The unique identifier for this vendor

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/contacts/{userId}'

Response

204 No Content

Success

403 Forbidden

Not allowed because you are changing your permissions.

409 Conflict

Not allowed to remove because it is the only contact for the vendor

Get payment details

GET /rest/2/vendors/{vendorId}/paymentInfo

Get the payment details for the specified vendor.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

vendorId REQUIRED

integer

The unique identifier for this vendor

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/paymentInfo'

Response

404 Not Found

The vendor has no payment information

Create / update payment details

PUT /rest/2/vendors/{vendorId}/paymentInfo

Create or update the payment details for a specific vendor.

Atlassian uses this information to send electronic payments for paid-via-Atlassian app sales. It is only required for vendors who are using the Atlassian payment and licensing system.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

vendorId REQUIRED

integer

The unique identifier for this vendor

Body parameters

SelfLinkOnly

address

Address

contact

VendorPaymentContact

payment

VendorPaymentAccount

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json' \
  --data '
    {
      "_links": {
        "self": {}
      },
      "address": {
        "city": "string",
        "country": "string",
        "line1": "string",
        "line2": "string",
        "postCode": "string",
        "state": "string"
      },
      "contact": {
        "email": "string",
        "firstName": "string",
        "lastName": "string"
      },
      "payment": {
        "accountAddress": "string",
        "accountCountry": "string",
        "accountName": "string",
        "accountNumberOrIban": "string",
        "bankAddress": "string",
        "bankCity": "string",
        "bankCountry": "string",
        "bankName": "string",
        "businessId": "string",
        "otherCodeNumber": "string",
        "otherCodeType": "string",
        "salesTaxId": "string",
        "swiftCode": "string",
        "taxId": "string"
      }
    }' \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/paymentInfo'

Response

204 No Content

Successfully modified

Get promotions

GET /rest/2/vendors/{vendorId}/promotions

Get a list of promotions for the specified vendor.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

vendorId REQUIRED

integer

The unique identifier for this vendor

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions'

Response

Create promotion

POST /rest/2/vendors/{vendorId}/promotions

Create a new promotion for the specified vendor.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

vendorId REQUIRED

integer

The unique identifier for this vendor

Body parameters

PromotionLinks

appliesToAllLicenseTypes

boolean

True if the promotion applies to all license types

discount

[DiscountEdition]

List of pricing tiers showing what the resulting discounts will be

discountPercent

integer

Discount percentage if this promotion is based on a percentage discount

discountType

string

Indicates whether the promotion uses percentage discounts or dollar amounts

Valid values:
  • PERCENTAGE
  • FLAT

endImmediatelyDate

string

Date and time when the promotion was stopped. This is only applicable when a promotion is ended early

expirationDate

string

Expiration date of the promotion

maxUses

integer

Maximum number of times this promotion can be used if it is a shared promotion

name

string

Name of the promotion

products

[string]

App keys of the apps for which this promotion is applicable

startDate

string

Starting date of the promotion

status

string

Current status of the promotion

Valid values:
  • ACTIVE
  • EXPIRED
  • ENDED-EARLY

usageType

string

Indicates whether this is a shared or single-use promotion

Valid values:
  • MULTI
  • SINGLE

used

integer

Number of times this promotion has been used

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json' \
  --data '
    {
      "_links": {
        "codes": {},
        "edit": {},
        "self": {
          "href": "string",
          "title": "string",
          "type": "string"
        },
        "status": {},
        "usage": {}
      },
      "appliesToAllLicenseTypes": true,
      "discount": [
        {
          "discountAmount": 123.456,
          "pricingItemId": "string"
        }
      ],
      "discountPercent": 123456,
      "discountType": "string",
      "endImmediatelyDate": "string",
      "expirationDate": "string",
      "maxUses": 123456,
      "name": "string",
      "products": [
        "string"
      ],
      "startDate": "string",
      "status": "string",
      "usageType": "string",
      "used": 123456
    }' \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions'

Response

201 Created

Successfully created

Get promotion

GET /rest/2/vendors/{vendorId}/promotions/{promotionId}

Get a specific promotion for the specified vendor.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

promotionId REQUIRED

string

The unique identifier for this promotion

vendorId REQUIRED

integer

The unique identifier for this vendor

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions/{promotionId}'

Response

Update promotion

PATCH /rest/2/vendors/{vendorId}/promotions/{promotionId}

Update a specific promotion for the specified vendor.

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.

Response content type: application/json

Request

Path parameters

promotionId REQUIRED

string

The unique identifier for this promotion

vendorId REQUIRED

integer

The unique identifier for this vendor

Body parameters

data

[JsonPatchDocumentation]

Example

curl --request PATCH \
  --user email@example.com:<api_token> \
  --header 'Content-Type: application/json-patch+json' \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions/{promotionId}'

Response

204 No Content

Successfully modified

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Get promotion codes

GET /rest/2/vendors/{vendorId}/promotions/{promotionId}/codes

Get a list of single-use codes for the specified promotion.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

promotionId REQUIRED

string

The unique identifier for this promotion

vendorId REQUIRED

integer

The unique identifier for this vendor

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions/{promotionId}/codes'

Response

Create promotion code

POST /rest/2/vendors/{vendorId}/promotions/{promotionId}/codes

Create a new single-use code for the specified promotion.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

promotionId REQUIRED

string

The unique identifier for this promotion

vendorId REQUIRED

integer

The unique identifier for this vendor

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions/{promotionId}/codes'

Response

Get promotion code

GET /rest/2/vendors/{vendorId}/promotions/{promotionId}/codes/{promotionCode}

Get a specific single-use code for the specified promotion.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

promotionCode REQUIRED

string

promotionId REQUIRED

string

The unique identifier for this promotion

vendorId REQUIRED

integer

The unique identifier for this vendor

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions/{promotionId}/codes/{promotionCode}'

Response

Delete promotion code

DELETE /rest/2/vendors/{vendorId}/promotions/{promotionId}/codes/{promotionCode}

Delete a specific single-use code for a specific promotion associated with a specific vendor.

Promotion codes can only be deleted prior to their use.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

promotionCode REQUIRED

string

promotionId REQUIRED

string

The unique identifier for this promotion

vendorId REQUIRED

integer

The unique identifier for this vendor

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions/{promotionId}/codes/{promotionCode}'

Response

200 OK

Successfully deleted

409 Conflict

Not allowed because the promotion code has already been used

Get promotion status

GET /rest/2/vendors/{vendorId}/promotions/{promotionId}/status

Get a specific promotion status for the specified vendor.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

promotionId REQUIRED

string

The unique identifier for this promotion

vendorId REQUIRED

integer

The unique identifier for this vendor

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions/{promotionId}/status'

Response

200 OK

Get reporting links

GET /rest/2/vendors/{vendorId}/reporting

Get links to permitted vendor reporting resources.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

vendorId REQUIRED

integer

The unique identifier for this vendor

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting'

Response

Get aggregated evaluations

GET /rest/2/vendors/{vendorId}/reporting/evaluations/{metric}

Get aggregated evaluations for the specified vendor, aggregated by the specified metric.

Evaluations can be aggregated by hosting, region, and more.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

metric REQUIRED

string

The unique identifier for this evaluation metric

Valid values:
  • country
  • hosting
  • partner
  • region

vendorId REQUIRED

integer

The unique identifier for this vendor

Query parameters

aggregation

string

The time aggregation

Valid values:
  • week
  • month

endDate

string

Ending date for the query

startDate

string

Starting date for the query

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/evaluations/{metric}'

Response

502 Bad Gateway

Temporarily unable to retrieve evaluation information

Get feedback

GET /rest/2/vendors/{vendorId}/reporting/feedback/details

Get a list of feedback for the specified vendor’s apps.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

vendorId REQUIRED

integer

The unique identifier for this vendor

Query parameters

addon

[string]

If specified, restricts the query to values for apps with the specified keys

anonymous

boolean

Restrict feedback to feedback that is either anonymous or by a known user

endDate

string

Ending date for the query

hosting

[string]

Restricts the query to values for these hosting types

limit

integer

If specified, limits the result set to this number of items

offset

integer

If specified, skips ahead by this number of items

reason

[string]

Restrict feedback to the specified reason

startDate

string

Starting date for the query

text

string

Text to search for in the reporter details (license id and email address) and the optional message

type

[string]

Restrict feedback to the specified type

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/feedback/details'

Response

Invalid properties

404 Not Found

The resource does not exist or isn’t visible to you

Export feedback

GET /rest/2/vendors/{vendorId}/reporting/feedback/details/export

Export all feedback, matching the specified filters, for the specified vendor’s apps.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

vendorId REQUIRED

integer

The unique identifier for this vendor

Query parameters

accept

string

Specifies the response format. If unspecified, the ‘Accept’ header will be used.

Valid values:
  • json
  • csv

addon

[string]

If specified, restricts the query to values for apps with the specified keys

anonymous

boolean

Restrict feedback to feedback that is either anonymous or by a known user

endDate

string

Ending date for the query

hosting

[string]

Restricts the query to values for these hosting types

reason

[string]

Restrict feedback to the specified reason

startDate

string

Starting date for the query

text

string

Text to search for in the reporter details (license id and email address) and the optional message

type

[string]

Restrict feedback to the specified type

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/feedback/details/export'

Response

200 OK

Get aggregated feedback

GET /rest/2/vendors/{vendorId}/reporting/feedback/metrics/{metric}

Get aggregated feedback for the specified vendor, aggregated by the specified metric.

Feedback can be aggregated by type and reason.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

metric REQUIRED

string

The unique identifier for this vendor feedback metric

Valid values:
  • type
  • reason

vendorId REQUIRED

integer

The unique identifier for this vendor

Query parameters

aggregation

string

The time aggregation

Valid values:
  • week
  • month

endDate

string

Ending date for the query

startDate

string

Starting date for the query

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/feedback/metrics/{metric}'

Response

Get licenses

GET /rest/2/vendors/{vendorId}/reporting/licenses

Get a list of licenses for the specified vendor’s apps.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

vendorId REQUIRED

integer

The unique identifier for this vendor

Query parameters

addon

[string]

If specified, restricts the query to values for apps with the specified keys

dateType

string

The date field against which filters will be applied

Valid values:
  • start
  • end

endDate

string

Ending date for the query

hosting

[string]

Restricts the query to values for these hosting types

lastUpdated

string

If specified, restricts the query to values updated on or after the specified date

licenseType

[string]

If specified, restricts the query to values with the provided license type; ‘inactive’ queries for expired licenses. Queries for ‘starter’ are deprecated; results may not be as expected

limit

integer

If specified, limits the result set to this number of items

offset

integer

If specified, skips ahead by this number of items

order

string

Determines whether values are sorted in ascending or descending order

Valid values:
  • asc
  • desc

partnerType

[string]

Specifies whether to query only direct sales, expert sales, or reseller sales

sortBy

string

If specified, determines the license sort order

Valid values:
  • addonName
  • company
  • country
  • startDate
  • endDate
  • tier
  • hosting
  • licenseId
  • licenseType
  • partner
  • region

startDate

string

Starting date for the query

status

[string]

If specified, restricts the query to values with the provided status

text

string

Text to search for in license fields (license id, customer information and partner information)

tier

[integer]

Restricts the query to values for these user/edition tiers

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/licenses'

Response

502 Bad Gateway

Temporarily unable to retrieve license information

Export licenses

GET /rest/2/vendors/{vendorId}/reporting/licenses/export

Export all licenses, matching the specified filters, for the specified vendor’s apps.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

vendorId REQUIRED

integer

The unique identifier for this vendor

Query parameters

accept

string

Specifies the response format. If unspecified, the ‘Accept’ header will be used.

Valid values:
  • json
  • csv

addon

[string]

If specified, restricts the query to values for apps with the specified keys

dateType

string

The date field against which filters will be applied

Valid values:
  • start
  • end

endDate

string

Ending date for the query

hosting

[string]

Restricts the query to values for these hosting types

lastUpdated

string

If specified, restricts the query to values updated on or after the specified date

licenseType

[string]

If specified, restricts the query to values with the provided license type; ‘inactive’ queries for expired licenses. Queries for ‘starter’ are deprecated; results may not be as expected

order

string

Determines whether values are sorted in ascending or descending order

Valid values:
  • asc
  • desc

partnerType

[string]

Specifies whether to query only direct sales, expert sales, or reseller sales

sortBy

string

If specified, determines the license sort order

Valid values:
  • addonName
  • company
  • country
  • startDate
  • endDate
  • tier
  • hosting
  • licenseId
  • licenseType
  • partner
  • region

startDate

string

Starting date for the query

status

[string]

If specified, restricts the query to values with the provided status

text

string

Text to search for in license fields (license id, customer information and partner information)

tier

[integer]

Restricts the query to values for these user/edition tiers

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/licenses/export'

Response

200 OK

502 Bad Gateway

Temporarily unable to retrieve license information

Get Cloud license events

GET /rest/2/vendors/{vendorId}/reporting/sales/metrics/{saleMetric}/details

Get the details about an individual Cloud license event (churn, conversion or renewal) for a specific vendor’s apps.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

saleMetric REQUIRED

string

Valid values:
  • churn
  • conversion
  • renewal

vendorId REQUIRED

integer

The unique identifier for this vendor

Query parameters

addon

[string]

If specified, restricts the query to values for apps with the specified keys

endDate

string

Ending date for the query

hosting

[string]

Restricts the query to values for these hosting types

lastUpdated

string

If specified, restricts the query to values updated on or after the specified date

order

string

Determines whether values are sorted in ascending or descending order

Valid values:
  • asc
  • desc

partnerType

[string]

Specifies whether to query only direct sales, expert sales, or reseller sales

sortBy

string

If specified, determines the data sort order

Valid values:
  • addonName
  • date
  • hosting
  • transactionId
  • licenseId

startDate

string

Starting date for the query

text

string

Text to search for (transaction id, license id, customer information and partner information)

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/sales/metrics/{saleMetric}/details'

Response

502 Bad Gateway

Temporarily unable to retrieve metrics information

Export Cloud license events

GET /rest/2/vendors/{vendorId}/reporting/sales/metrics/{saleMetric}/details/export

Export all Cloud license events, matching the specified filters, for the specified vendor’s apps.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

saleMetric REQUIRED

string

Valid values:
  • churn
  • conversion
  • renewal

vendorId REQUIRED

integer

The unique identifier for this vendor

Query parameters

accept

string

Specifies the response format. If unspecified, the ‘Accept’ header will be used.

Valid values:
  • json
  • csv

addon

[string]

If specified, restricts the query to values for apps with the specified keys

endDate

string

Ending date for the query

hosting

[string]

Restricts the query to values for these hosting types

lastUpdated

string

If specified, restricts the query to values updated on or after the specified date

order

string

Determines whether values are sorted in ascending or descending order

Valid values:
  • asc
  • desc

partnerType

[string]

Specifies whether to query only direct sales, expert sales, or reseller sales

sortBy

string

If specified, determines the data sort order

Valid values:
  • addonName
  • date
  • hosting
  • transactionId
  • licenseId

startDate

string

Starting date for the query

text

string

Text to search for (transaction id, license id, customer information and partner information)

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/sales/metrics/{saleMetric}/details/export'

Response

200 OK

502 Bad Gateway

Temporarily unable to retrieve metrics information

Get Cloud churn

GET /rest/2/vendors/{vendorId}/reporting/sales/metrics/churn

Get a list of Cloud churn events for the specified vendor’s apps.

For a given period, churn is calculated as the number of paying customers that have an opportunity to renew and choose to stop paying.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

vendorId REQUIRED

integer

The unique identifier for this vendor

Query parameters

aggregation

string

The time aggregation

Valid values:
  • week
  • month

endDate

string

Ending date for the query

startDate

string

Starting date for the query

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/sales/metrics/churn'

Response

502 Bad Gateway

Temporarily unable to retrieve sale information

Get Cloud conversions

GET /rest/2/vendors/{vendorId}/reporting/sales/metrics/conversion

Get a list of Cloud conversion events for the specified vendor’s apps.

For a given period, conversions are calculated as the number of evaluation licenses that converted into paid licenses.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

vendorId REQUIRED

integer

The unique identifier for this vendor

Query parameters

aggregation

string

The time aggregation

Valid values:
  • week
  • month

endDate

string

Ending date for the query

startDate

string

Starting date for the query

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/sales/metrics/conversion'

Response

502 Bad Gateway

Temporarily unable to retrieve sale information

Get Cloud renewals

GET /rest/2/vendors/{vendorId}/reporting/sales/metrics/renewal

Get a list of Cloud renewal events for the specified vendor’s apps.

For a given period, renewals are calculated as the number of paying customers that have an opportunity to renew and choose to continue paying.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

vendorId REQUIRED

integer

The unique identifier for this vendor

Query parameters

aggregation

string

The time aggregation

Valid values:
  • week
  • month

endDate

string

Ending date for the query

startDate

string

Starting date for the query

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/sales/metrics/renewal'

Response

502 Bad Gateway

Temporarily unable to retrieve sale information

Get transactions

GET /rest/2/vendors/{vendorId}/reporting/sales/transactions

Get a list of transactions for the specified vendor’s apps.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

vendorId REQUIRED

integer

The unique identifier for this vendor

Query parameters

addon

[string]

If specified, restricts the query to values for apps with the specified keys

endDate

string

Ending date for the query

hosting

[string]

Restricts the query to values for these hosting types

lastUpdated

string

If specified, restricts the query to values updated on or after the specified date

limit

integer

If specified, limits the result set to this number of items

offset

integer

If specified, skips ahead by this number of items

order

string

Determines whether values are sorted in ascending or descending order

Valid values:
  • asc
  • desc

partnerType

[string]

Specifies whether to query only direct sales, expert sales, or reseller sales

saleType

[string]

Restricts the query to sales of these types

sortBy

string

If specified, determines the transaction sort order

Valid values:
  • addonName
  • partnerType
  • country
  • date
  • partner
  • hosting
  • transactionId
  • licenseId
  • licenseType
  • company
  • region
  • purchasePrice
  • saleType
  • tier

startDate

string

Starting date for the query

text

string

Text to search for in transaction fields (transaction id, license id, customer information and partner information)

tier

[integer]

Restricts the query to values for these user/edition tiers

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/sales/transactions'

Response

502 Bad Gateway

Temporarily unable to retrieve transaction information

Get aggregated sales

GET /rest/2/vendors/{vendorId}/reporting/sales/transactions/{metric}

Get aggregated sales for the specified vendor, aggregated by the specified metric.

Sales can be aggregated by hosting, region, and more.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

metric REQUIRED

string

The unique identifier for this sale metric

Valid values:
  • country
  • hosting
  • partner
  • region
  • type
  • tier

vendorId REQUIRED

integer

The unique identifier for this vendor

Query parameters

aggregation

string

The time aggregation

Valid values:
  • week
  • month

endDate

string

Ending date for the query

startDate

string

Starting date for the query

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/sales/transactions/{metric}'

Response

502 Bad Gateway

Temporarily unable to retrieve sale information

Export transactions

GET /rest/2/vendors/{vendorId}/reporting/sales/transactions/export

Export all transactions, matching the specified filters, for the specified vendor’s apps.

This resource requires authentication.

Response content type: application/json

Request

Path parameters

vendorId REQUIRED

integer

The unique identifier for this vendor

Query parameters

accept

string

Specifies the response format. If unspecified, the ‘Accept’ header will be used.

Valid values:
  • json
  • csv

addon

[string]

If specified, restricts the query to values for apps with the specified keys

endDate

string

Ending date for the query

hosting

[string]

Restricts the query to values for these hosting types

lastUpdated

string

If specified, restricts the query to values updated on or after the specified date

order

string

Determines whether values are sorted in ascending or descending order

Valid values:
  • asc
  • desc

partnerType

[string]

Specifies whether to query only direct sales, expert sales, or reseller sales

saleType

[string]

Restricts the query to sales of these types

sortBy

string

If specified, determines the transaction sort order

Valid values:
  • addonName
  • partnerType
  • country
  • date
  • partner
  • hosting
  • transactionId
  • licenseId
  • licenseType
  • company
  • region
  • purchasePrice
  • saleType
  • tier

startDate

string

Starting date for the query

text

string

Text to search for in transaction fields (transaction id, license id, customer information and partner information)

tier

[integer]

Restricts the query to values for these user/edition tiers

Example

curl --user email@example.com:<api_token> \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/sales/transactions/export'

Response

200 OK

502 Bad Gateway

Temporarily unable to retrieve transaction information