Retrieves listing information for the specified Marketplace app (identified by productId). The response includes core listing metadata such as productId, appKey, developerId, appName, communityEnabled, state, approvalStatus, slug, cloudComplianceBoundary, and additional fields like summary, tagLine, images, and tags.

This endpoint has no query parameters.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

productId

string

Required

Responses

Successfully retrieved Marketplace app listing information

application/json

object

GET/rest/3/product-listing/{productId}

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/marketplace/rest/3/product-listing/{productId}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "productId": "12345678-1234-1234-1234-123456789abc",
  "appKey": "com.example.app.addon",
  "developerId": "87654321-4321-4321-4321-210987654321",
  "appName": "Example App for Platform",
  "summary": "This addon allows seamless integration between platform and external productivity tools for enhanced workflow management",
  "tagLine": "Streamline your workflow with powerful integrations",
  "images": {
    "iconFileId": "abc12345-6789-def0-1234-56789abcdef0",
    "titleLogoFileId": "def67890-abcd-1234-5678-90abcdef1234",
    "bannerFileId": "ghi34567-890a-bcde-f123-456789012345"
  },
  "tags": {
    "category": [
      {
        "id": "productivity",
        "name": "Productivity"
      },
      {
        "id": "workflow",
        "name": "Workflow Management"
      }
    ],
    "keywords": [
      {
        "id": "automation",
        "name": "Automation"
      },
      {
        "id": "efficiency",
        "name": "Efficiency"
      }
    ]
  },
  "communityEnabled": true,
  "developerLinks": {
    "issueTracker": "https://issues.example.com/browse/PROJ",
    "supportTicketSystem": "https://support.example.com/servicedesk/customer/portal/1",
    "appStatusPage": "https://status.example.com",
    "forums": "https://community.example.com",
    "privacy": "https://example.com/privacy-policy"
  },
  "thirdPartyIntegrations": {
    "googleAnalyticsId": "UA-12345678-1",
    "googleAnalytics4Id": "G-ABCDEFGHIJ",
    "segmentWriteKey": "xyz789abc123def456ghi",
    "jsdEmbeddedDataKey": "jsd_key_example_123"
  },
  "enrolledPrograms": [
    {
      "id": "bugBountyParticipant",
      "name": "Bug Bounty Participant Program",
      "hostingType": "SERVER",
      "status": "APPROVED"
    },
    {
      "id": "bugBountyParticipant",
      "name": "Bug Bounty Participant Program",
      "hostingType": "CLOUD",
      "status": "APPROVED"
    },
    {
      "id": "cloudFortified",
      "name": "Cloud Fortified Program",
      "hostingType": "CLOUD",
      "status": "NON_PARTICIPANT"
    }
  ],
  "state": "PUBLIC",
  "approvalStatus": "APPROVED",
  "approvalDetails": {
    "issueKey": "MKPLHELP-12345",
    "approvalDate": "2023-05-15T14:30:00.000Z",
    "submittedDate": "2023-05-10T09:15:30.000Z",
    "approvedBy": "admin@example.com"
  },
  "slug": "example-app-for-platform",
  "revision": 15,
  "cloudComplianceBoundary": true,
  "dataCenterReviewIssueKey": "DCHELP-123",
  "hostingVisibility": {
    "cloud": "site",
    "server": null,
    "dataCenter": "app"
  },
  "stateAfterApproval": "PUBLIC",
  "marketingLabels": [
    "jira-servicedesk"
  ]
}

PUT

Update Marketplace app listing

Update the app level listing information of an existing Marketplace app.

This endpoint allows developers to update various aspects of their app listing including:

App metadata (name, summary, tagline)
Visual assets (icon, title logo, banner)
Tags for categorization and discovery
Developer links and support information
Third-party integrations
Community settings

Field Update Restrictions:

Non-updatable fields (read-only for developers):

appKey - App key cannot be changed after creation
developerId - Developer Id can not be using using this API. Contact Marketplace support for any help.
images.titleLogoFileId - Only updatable by marketplace administrators
enrolledPrograms - Managed by Atlassian marketplace team
state - Not enabled currently using this API. You can use Marketplace UI to update
approvalStatus - Not enabled currently using this API. You can use Marketplace UI to update
hostingVisibility - Only updatable by marketplace administrators
stateAfterApproval - Can't modify stateAfterApproval if state of app is already PUBLIC or READY_TO_LAUNCH
revision - System-managed field for conflict resolution

Important: For non-updatable fields, you must pass the current values from the Get Marketplace app listing (/rest/3/product-listing/{productId}) API response to avoid validation errors.

Recommended workflow:

First, fetch the current app listing using the Get Marketplace app listing (/rest/3/product-listing/{productId}) API
Update only the fields you want to change (excluding non-updatable fields listed above)
Keep all other fields the same as the GET response, including fields you don't want to update
Make the PUT request with the modified payload

All other fields in the request schema are updatable by developers, but should be passed with their current values if you don't intend to change them.

Usage Examples:

Update app name and summary:


1
PUT /rest/3/product-listing/12345678-1234-1234-1234-123456789abc

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

productId

string

Required

Request bodyapplication/json

appKey

string

Required

developerId

string

Required

appName

string

Required

summary

string

tagLine

string

images

ImagesV3Request

tags

TagsV3Request

communityEnabled

boolean

Required

developerLinks

ProductExternalLinksV3Request

thirdPartyIntegrations

ThirdPartyIntegrationsV3Request

Responses

Marketplace app listing updated successfully

application/json

object

PUT/rest/3/product-listing/{productId}

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'https://api.atlassian.com/marketplace/rest/3/product-listing/{productId}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "appKey": "com.example.updated.addon",
  "developerId": "87654321-4321-4321-4321-210987654321",
  "appName": "Updated Example App",
  "summary": "This updated addon provides enhanced integration capabilities",
  "tagLine": "Enhanced workflow automation for modern teams",
  "images": {
    "iconFileId": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "titleLogoFileId": "f7e8d9c0-b1a2-3456-789a-bcdef0123456",
    "bannerFileId": "3456789a-bcde-f012-3456-789abcdef012"
  },
  "tags": {
    "category": [
      "productivity",
      "workflow"
    ],
    "keywords": [
      "efficiency",
      "teamwork"
    ]
  },
  "communityEnabled": true,
  "developerLinks": {
    "issueTracker": "https://updated-issues.example.com/browse/PROJ",
    "supportTicketSystem": "https://updated-support.example.com/servicedesk/customer/portal/1",
    "appStatusPage": "https://updated-status.example.com",
    "forums": "https://updated-community.example.com",
    "privacy": "https://updated-example.com/privacy-policy"
  },
  "thirdPartyIntegrations": {
    "googleAnalyticsId": "UA-87654321-9",
    "googleAnalytics4Id": "G-NEWANALYTICS",
    "segmentWriteKey": "newSegmentKey123",
    "jsdEmbeddedDataKey": "9f8e7d6c-5b4a-3928-1716-fedcba987654"
  },
  "enrolledPrograms": [
    {
      "id": "bugBountyParticipant",
      "name": "Bug Bounty Participant",
      "hostingType": "CLOUD",
      "status": "APPROVED"
    },
    {
      "id": "cloudFortified",
      "name": "Cloud Fortified Program",
      "hostingType": "CLOUD",
      "status": "NON_PARTICIPANT"
    }
  ],
  "state": "PUBLIC",
  "approvalStatus": "SUBMITTED",
  "dataCenterReviewIssueKey": "DCHELP-456",
  "hostingVisibility": {
    "cloud": "app",
    "server": "site",
    "dataCenter": null
  },
  "stateAfterApproval": "READY_TO_LAUNCH",
  "marketingLabels": [
    "jira-servicedesk"
  ],
  "revision": 16
}'

200Response

{
  "productId": "12345678-1234-1234-1234-123456789abc",
  "appKey": "com.example.updated.addon",
  "developerId": "87654321-4321-4321-4321-210987654321",
  "appName": "Updated Example App",
  "summary": "This updated addon provides enhanced integration capabilities",
  "tagLine": "Enhanced workflow automation for modern teams",
  "images": {
    "iconFileId": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "titleLogoFileId": "f7e8d9c0-b1a2-3456-789a-bcdef0123456",
    "bannerFileId": "3456789a-bcde-f012-3456-789abcdef012"
  },
  "tags": {
    "category": [
      {
        "id": "productivity",
        "name": "Productivity"
      },
      {
        "id": "workflow",
        "name": "Workflow Management"
      }
    ],
    "keywords": [
      {
        "id": "efficiency",
        "name": "Efficiency"
      },
      {
        "id": "teamwork",
        "name": "Teamwork"
      }
    ]
  },
  "communityEnabled": true,
  "developerLinks": {
    "issueTracker": "https://updated-issues.example.com/browse/PROJ",
    "supportTicketSystem": "https://updated-support.example.com/servicedesk/customer/portal/1",
    "appStatusPage": "https://updated-status.example.com",
    "forums": "https://updated-community.example.com",
    "privacy": "https://updated-example.com/privacy-policy"
  },
  "thirdPartyIntegrations": {
    "googleAnalyticsId": "UA-87654321-9",
    "googleAnalytics4Id": "G-NEWANALYTICS",
    "segmentWriteKey": "newSegmentKey123",
    "jsdEmbeddedDataKey": "9f8e7d6c-5b4a-3928-1716-fedcba987654"
  },
  "enrolledPrograms": [
    {
      "id": "bugBountyParticipant",
      "name": "Bug Bounty Participant Program",
      "hostingType": "SERVER",
      "status": "APPROVED"
    },
    {
      "id": "cloudFortified",
      "name": "Cloud Fortified Program",
      "hostingType": "CLOUD",
      "status": "APPLIED"
    }
  ],
  "state": "PUBLIC",
  "approvalStatus": "SUBMITTED",
  "approvalDetails": {
    "issueKey": "MKPLHELP-54321",
    "submittedDate": "2023-12-01T10:30:00.000Z"
  },
  "slug": "updated-example-app",
  "revision": 16,
  "cloudComplianceBoundary": true,
  "dataCenterReviewIssueKey": "DCHELP-456",
  "hostingVisibility": {
    "cloud": "app",
    "server": "site",
    "dataCenter": null
  },
  "stateAfterApproval": "READY_TO_LAUNCH",
  "marketingLabels": [
    "jira-servicedesk"
  ]
}

GET

Get Marketplace app listings for a developer

Get paginated listing information for all Marketplace apps associated with a developer

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

developerId

string

Required

Query parameters

limit

integer

cursor

string

includePrivate

boolean

Responses

Successfully retrieved Marketplace app listings for developer

application/json

object

GET/rest/3/product-listing/developer-space/{developerId}

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://api.atlassian.com/marketplace/rest/3/product-listing/developer-space/{developerId}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "links": {
    "self": "/rest/3/product-listing/developer-space/87654321-4321-4321-4321-210987654321?limit=10",
    "next": "/rest/3/product-listing/developer-space/87654321-4321-4321-4321-210987654321?limit=10&cursor=eyJwcm9kdWN0SWQiOiI5ODc2NTQzMi04NzY1LTQzMjEtODc2NS00MzIxMDk4NzY1NDMifQ=="
  },
  "items": [
    {
      "productId": "12345678-1234-1234-1234-123456789abc",
      "appKey": "com.example.app.addon",
      "developerId": "87654321-4321-4321-4321-210987654321",
      "appName": "Example App for Platform",
      "summary": "This addon allows seamless integration between platform and external productivity tools for enhanced workflow management",
      "tagLine": "Streamline your workflow with powerful integrations",
      "images": {
        "iconFileId": "abc12345-6789-def0-1234-56789abcdef0",
        "titleLogoFileId": "def67890-abcd-1234-5678-90abcdef1234",
        "bannerFileId": "ghi34567-890a-bcde-f123-456789012345"
      },
      "tags": {
        "category": [
          {
            "id": "productivity",
            "name": "Productivity"
          },
          {
            "id": "workflow",
            "name": "Workflow Management"
          }
        ],
        "keywords": [
          {
            "id": "automation",
            "name": "Automation"
          },
          {
            "id": "efficiency",
            "name": "Efficiency"
          }
        ]
      },
      "communityEnabled": true,
      "developerLinks": {
        "issueTracker": "https://issues.example.com/browse/PROJ",
        "supportTicketSystem": "https://support.example.com/servicedesk/customer/portal/1",
        "appStatusPage": "https://status.example.com",
        "forums": "https://community.example.com",
        "privacy": "https://example.com/privacy-policy"
      },
      "thirdPartyIntegrations": {
        "googleAnalyticsId": "UA-12345678-1",
        "googleAnalytics4Id": "G-ABCDEFGHIJ",
        "segmentWriteKey": "xyz789abc123def456ghi",
        "jsdEmbeddedDataKey": "jsd_key_example_123"
      },
      "enrolledPrograms": [
        {
          "id": "bugBountyParticipant",
          "name": "Bug Bounty Participant Program",
          "hostingType": "SERVER",
          "status": "APPROVED"
        },
        {
          "id": "bugBountyParticipant",
          "name": "Bug Bounty Participant Program",
          "hostingType": "CLOUD",
          "status": "APPROVED"
        },
        {
          "id": "cloudFortified",
          "name": "Cloud Fortified Program",
          "hostingType": "CLOUD",
          "status": "NON_PARTICIPANT"
        }
      ],
      "state": "PUBLIC",
      "approvalStatus": "APPROVED",
      "approvalDetails": {
        "issueKey": "MKPLHELP-12345",
        "approvalDate": "2023-05-15T14:30:00.000Z",
        "submittedDate": "2023-05-10T09:15:30.000Z",
        "approvedBy": "admin@example.com"
      },
      "slug": "example-app-for-platform",
      "revision": 15,
      "cloudComplianceBoundary": true,
      "dataCenterReviewIssueKey": "DCHELP-789",
      "hostingVisibility": {
        "cloud": "site",
        "server": null,
        "dataCenter": "app"
      },
      "stateAfterApproval": "PUBLIC"
    },
    {
      "productId": "98765432-8765-4321-8765-432109876543",
      "appKey": "com.example.another.addon",
      "developerId": "87654321-4321-4321-4321-210987654321",
      "appName": "Another Example App",
      "summary": "A second app for demonstration purposes",
      "tagLine": "Enhance your productivity with advanced features",
      "images": {
        "iconFileId": "xyz98765-4321-abcd-9876-543210fedcba",
        "titleLogoFileId": "uvw54321-dcba-9876-5432-10fedcba9876",
        "bannerFileId": "rst87654-3210-fedc-ba98-765432109876"
      },
      "tags": {
        "category": [
          {
            "id": "utilities",
            "name": "Utilities"
          }
        ],
        "keywords": [
          {
            "id": "advanced",
            "name": "Advanced"
          }
        ]
      },
      "communityEnabled": false,
      "developerLinks": {
        "issueTracker": "https://issues.another-example.com/browse/PROJ",
        "supportTicketSystem": "https://support.another-example.com/servicedesk/customer/portal/1",
        "privacy": "https://another-example.com/privacy-policy"
      },
      "thirdPartyIntegrations": {
        "googleAnalyticsId": "UA-87654321-2",
        "segmentWriteKey": "abc123def456ghi789jkl"
      },
      "enrolledPrograms": [
        {
          "id": "cloudFortified",
          "name": "Cloud Fortified Program",
          "hostingType": "CLOUD",
          "status": "APPROVED"
        }
      ],
      "state": "PUBLIC",
      "approvalStatus": "APPROVED",
      "approvalDetails": {
        "issueKey": "MKPLHELP-67890",
        "approvalDate": "2023-06-20T10:45:00.000Z",
        "submittedDate": "2023-06-15T14:20:15.000Z",
        "approvedBy": "admin@example.com"
      },
      "slug": "another-example-app",
      "revision": 8,
      "cloudComplianceBoundary": false,
      "dataCenterReviewIssueKey": "DCHELP-101",
      "hostingVisibility": {
        "cloud": null,
        "server": "app",
        "dataCenter": "site"
      },
      "stateAfterApproval": "PRIVATE",
      "marketingLabels": [
        "jira-servicedesk"
      ]
    }
  ]
}