Rate this page:

Products

Information about products

Get products

GET /rest/2/products

Get a list of products matching the specified parameters.

Request

Query parameters
application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

Format: int64
cost

string

Only returns apps with the specified payment model

Valid values: free, marketplace, orderable, paid

hosting

string

Only returns apps with the specified hosting model

Valid values: any, cloud, datacenter, server

withVersion

boolean

Includes the latest compatible version in the response

offset

integer

If specified, skips ahead by this number of items

Format: int32
limit

integer

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

Format: int32

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/products' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

ProductCollection

Get product

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

Get a specific product.

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

Format: int64
cost

string

Only returns apps with the specified payment model

Valid values: free, marketplace, orderable, paid

hosting

string

Only returns apps with the specified hosting model

Valid values: any, cloud, datacenter, server

withVersion

boolean

Includes the latest compatible version in the response

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/products/key/{productKey}' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

Product

Get product versions

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

Get a list of versions for the specified product.

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

Format: int64
cost

string

Only returns apps with the specified payment model

Valid values: free, marketplace, orderable, paid

hosting

string

Only returns apps with the specified hosting model

Valid values: any, cloud, datacenter, server

offset

integer

If specified, skips ahead by this number of items

Format: int32
limit

integer

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

Format: int32

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/products/key/{productKey}/versions' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

ProductVersionCollection

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.

Request

Path parameters
productKey Required

string

The unique identifier for this product, for example "jira-software"

buildNumber Required

integer

The unique internal identifier and sort key for this version

Format: int32
Query parameters
application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

Format: int64
cost

string

Only returns apps with the specified payment model

Valid values: free, marketplace, orderable, paid

hosting

string

Only returns apps with the specified hosting model

Valid values: any, cloud, datacenter, server

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/products/key/{productKey}/versions/build/{buildNumber}' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

ProductVersion

Get product version (latest)

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

Get the latest version of the specified product.

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

Format: int64
cost

string

Only returns apps with the specified payment model

Valid values: free, marketplace, orderable, paid

hosting

string

Only returns apps with the specified hosting model

Valid values: any, cloud, datacenter, server

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/products/key/{productKey}/versions/latest' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

ProductVersion

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.

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

Format: int64
cost

string

Only returns apps with the specified payment model

Valid values: free, marketplace, orderable, paid

hosting

string

Only returns apps with the specified hosting model

Valid values: any, cloud, datacenter, server

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/products/key/{productKey}/versions/name/{versionName}' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

ProductVersion

Rate this page: