Information about App version listing.
Retrieves listing information for a specific version of the app software identified by build number.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredinteger
RequiredSuccessfully retrieved app version listing information
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/marketplace/rest/3/app-software/{appSoftwareId}/versions/{buildNumber}/listing' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
{
"screenshots": [
{
"caption": "Task management interface with board view",
"imageId": "f1e2d3c4-b5a6-9c8d-7e6f-123456789abc"
},
{
"caption": "Team collaboration workspace",
"imageId": "a9b8c7d6-e5f4-3210-9876-fedcba987654"
},
{
"caption": "Project timeline and milestones",
"imageId": "c3d4e5f6-a7b8-9c0d-1e2f-456789abcdef"
}
],
"highlights": [
{
"title": "Smart Workflows",
"caption": "Automate repetitive tasks efficiently",
"summary": "Streamline your processes with intelligent automation",
"screenshot": {
"caption": "Workflow automation setup",
"imageId": "e7f8a9b0-c1d2-3e4f-5a6b-789012345678"
},
"thumbnail": "d6e7f8a9-b0c1-2d3e-4f5a-890123456789"
},
{
"title": "Team Dashboard",
"caption": "Real-time project visibility",
"summary": "Monitor progress with interactive dashboards",
"screenshot": {
"caption": "Team performance dashboard",
"imageId": "b4c5d6e7-f8a9-0b1c-2d3e-567890123456"
},
"thumbnail": "f0a1b2c3-d4e5-6f7a-8b9c-234567890123"
},
{
"title": "Advanced Reporting",
"caption": "Comprehensive analytics and insights",
"summary": "Generate detailed reports with customizable metrics",
"screenshot": {
"caption": "Advanced reporting interface",
"imageId": "c5d6e7f8-a9b0-1c2d-3e4f-678901234567"
},
"thumbnail": "e9f0a1b2-c3d4-5e6f-7a8b-012345678901"
}
],
"moreDetails": "This version introduces enhanced project tracking, improved team collaboration tools, and advanced reporting capabilities for better project management.",
"heroImage": "h1e2r3o4-i5m6-a7g8-e9u0-123456789abc",
"youtubeId": "xyz789ABC456",
"deploymentInstructions": [
{
"body": "1. Download and install the app from Marketplace",
"screenshot": {
"caption": "App installation process",
"imageId": "a5b6c7d8-e9f0-1a2b-3c4d-567890abcdef"
}
},
{
"body": "2. Configure project settings and team permissions",
"screenshot": {
"caption": "Configuration dashboard",
"imageId": "d2e3f4a5-b6c7-8d9e-0f1a-234567890123"
}
},
{
"body": "3. Import existing data and train your team",
"screenshot": {}
}
],
"developerLinks": {
"documentation": "https://docs.projectapp.com/guide",
"learnMore": "https://projectapp.com/features",
"eula": "https://projectapp.com/terms",
"purchase": "https://marketplace.atlassian.com/apps/projectapp",
"bonTermsSupported": true,
"partnerSpecificTerms": "Custom partner terms and conditions apply"
},
"state": "PUBLIC",
"approvalStatus": "APPROVED",
"approvalDetails": {
"issueKey": "MKPLHELP-98765",
"approvalDate": "2023-09-20T15:30:00.000Z",
"submittedDate": "2023-09-15T10:15:00.000Z",
"approvedBy": "marketplace-admin@atlassian.com"
},
"buildNumber": 12345,
"appSoftwareId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"revision": 5
}Update listing information for the specified app software version.
This endpoint allows developers to update comprehensive listing information including:
Approval Status Transition Restrictions:
REJECTED → PENDING_REVIEWRecommended workflow:
/rest/3/app-software/{appSoftwareId}/versions/{buildNumber}/listing) APIUsage Examples:
1PUT /rest/3/app-software/a1b2c3d4-e5f6-7890-abcd-ef1234567890/versions/42/listing
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredinteger
Requiredarray<AppSoftwareVersionListingScreenshotV3Request>
array<AppSoftwareVersionListingHighLightsV3Request>
string
string
string
array<AppSoftwareVersionListingDeploymentInstructionV3Request>
AppSoftwareVersionListingV3Links
string
Requiredstring
Requiredinteger
RequiredApp version listing updated successfully
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
curl --request PUT \
--url 'https://api.atlassian.com/marketplace/rest/3/app-software/{appSoftwareId}/versions/{buildNumber}/listing' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"screenshots": [
{
"caption": "Updated dashboard interface",
"imageId": "f1e2d3c4-b5a6-9c8d-7e6f-123456789abc"
},
{
"caption": "Enhanced task management board",
"imageId": "a9b8c7d6-e5f4-3210-9876-fedcba987654"
}
],
"highlights": [
{
"title": "Advanced Automation",
"caption": "Next-level workflow automation",
"summary": "Enhanced automation capabilities with machine learning integration for smarter workflows",
"screenshot": {
"caption": "ML-powered automation dashboard",
"imageId": "e7f8a9b0-c1d2-3e4f-5a6b-789012345678"
},
"thumbnail": "d6e7f8a9-b0c1-2d3e-4f5a-890123456789"
},
{
"title": "AI-Powered Insights",
"caption": "Intelligent data analysis and recommendations",
"summary": "Leverage artificial intelligence to gain deeper insights and automated recommendations",
"screenshot": {
"caption": "AI insights dashboard",
"imageId": "f8a9b0c1-d2e3-4f5a-6b7c-890123456789"
},
"thumbnail": "a0b1c2d3-e4f5-6a7b-8c9d-123456789012"
},
{
"title": "Enhanced Security",
"caption": "Enterprise-grade security features",
"summary": "Advanced security protocols and compliance features for enterprise environments",
"screenshot": {
"caption": "Security configuration panel",
"imageId": "b1c2d3e4-f5a6-7b8c-9d0e-234567890123"
},
"thumbnail": "c2d3e4f5-a6b7-8c9d-0e1f-345678901234"
}
],
"moreDetails": "This updated version introduces enhanced project tracking capabilities, improved team collaboration tools, advanced AI-powered insights, and comprehensive reporting features for better project management.",
"heroImage": "h1e2r3o4-i5m6-a7g8-e9u0-123456789abc",
"youtubeId": "dQw4w9WgXcQ",
"deploymentInstructions": [
{
"body": "Download and install the updated app from the Atlassian Marketplace",
"screenshot": {
"caption": "Updated marketplace installation page",
"imageId": "a5b6c7d8-e9f0-1a2b-3c4d-567890abcdef"
}
},
{
"body": "Run the migration script to upgrade your existing data and configurations",
"screenshot": {
"caption": "Migration process interface",
"imageId": "d2e3f4a5-b6c7-8d9e-0f1a-234567890123"
}
}
],
"developerLinks": {
"documentation": "https://docs.projectapp.com/v2.1",
"learnMore": "https://projectapp.com/features-v2.1",
"eula": "https://projectapp.com/license-v2",
"purchase": "https://marketplace.atlassian.com/apps/1234567/projectapp",
"bonTermsSupported": true,
"partnerSpecificTerms": "Custom partner terms and conditions apply"
},
"state": "PUBLIC",
"approvalStatus": "SUBMITTED",
"revision": 6
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
{
"screenshots": [
{
"caption": "Updated dashboard interface",
"imageId": "f1e2d3c4-b5a6-9c8d-7e6f-123456789abc"
},
{
"caption": "Enhanced task management board",
"imageId": "a9b8c7d6-e5f4-3210-9876-fedcba987654"
}
],
"highlights": [
{
"title": "Advanced Automation",
"caption": "Next-level workflow automation",
"summary": "Enhanced automation capabilities with machine learning integration for smarter workflows",
"screenshot": {
"caption": "ML-powered automation dashboard",
"imageId": "e7f8a9b0-c1d2-3e4f-5a6b-789012345678"
},
"thumbnail": "d6e7f8a9-b0c1-2d3e-4f5a-890123456789"
},
{
"title": "AI-Powered Insights",
"caption": "Intelligent data analysis and recommendations",
"summary": "Leverage artificial intelligence to gain deeper insights and automated recommendations",
"screenshot": {
"caption": "AI insights dashboard",
"imageId": "f8a9b0c1-d2e3-4f5a-6b7c-890123456789"
},
"thumbnail": "a0b1c2d3-e4f5-6a7b-8c9d-123456789012"
},
{
"title": "Enhanced Security",
"caption": "Enterprise-grade security features",
"summary": "Advanced security protocols and compliance features for enterprise environments",
"screenshot": {
"caption": "Security configuration panel",
"imageId": "b1c2d3e4-f5a6-7b8c-9d0e-234567890123"
},
"thumbnail": "c2d3e4f5-a6b7-8c9d-0e1f-345678901234"
}
],
"moreDetails": "This updated version introduces enhanced project tracking capabilities, improved team collaboration tools, advanced AI-powered insights, and comprehensive reporting features for better project management.",
"heroImage": "h1e2r3o4-i5m6-a7g8-e9u0-123456789abc",
"youtubeId": "dQw4w9WgXcQ",
"deploymentInstructions": [
{
"body": "Download and install the updated app from the Atlassian Marketplace",
"screenshot": {
"caption": "Updated marketplace installation page",
"imageId": "a5b6c7d8-e9f0-1a2b-3c4d-567890abcdef"
}
},
{
"body": "Run the migration script to upgrade your existing data and configurations",
"screenshot": {
"caption": "Migration process interface",
"imageId": "d2e3f4a5-b6c7-8d9e-0f1a-234567890123"
}
}
],
"developerLinks": {
"documentation": "https://docs.projectapp.com/v2.1",
"learnMore": "https://projectapp.com/features-v2.1",
"eula": "https://projectapp.com/license-v2",
"purchase": "https://marketplace.atlassian.com/apps/1234567/projectapp",
"bonTermsSupported": true,
"partnerSpecificTerms": "Custom partner terms and conditions apply"
},
"state": "PUBLIC",
"approvalStatus": "SUBMITTED",
"approvalDetails": {
"issueKey": "MKPLHELP-98765",
"submittedDate": "2023-12-01T14:30:00.000Z"
},
"buildNumber": 42,
"appSoftwareId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"revision": 6
}Create listing information for the specified app software version.
This endpoint allows developers to create comprehensive listing information including:
Usage Examples:
1POST /rest/3/app-software/a1b2c3d4-e5f6-7890-abcd-ef1234567890/versions/42/listing
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredinteger
Requiredarray<AppSoftwareVersionListingScreenshotV3Request>
array<AppSoftwareVersionListingHighLightsV3Request>
string
string
string
array<AppSoftwareVersionListingDeploymentInstructionV3Request>
AppSoftwareVersionListingV3Links
string
RequiredApp version listing created successfully
string
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
curl --request POST \
--url 'https://api.atlassian.com/marketplace/rest/3/app-software/{appSoftwareId}/versions/{buildNumber}/listing' \
--user 'email@example.com:<api_token>' \
--header 'Content-Type: application/json' \
--data '{
"screenshots": [
{
"caption": "Main dashboard interface",
"imageId": "f1e2d3c4-b5a6-9c8d-7e6f-123456789abc"
},
{
"caption": "Task management board",
"imageId": "a9b8c7d6-e5f4-3210-9876-fedcba987654"
}
],
"highlights": [
{
"title": "Smart Automation",
"caption": "Automate your workflow efficiently",
"summary": "Reduce manual work with intelligent automation features that learn from your patterns",
"screenshot": {
"caption": "Automation setup wizard",
"imageId": "e7f8a9b0-c1d2-3e4f-5a6b-789012345678"
},
"thumbnail": "d6e7f8a9-b0c1-2d3e-4f5a-890123456789"
},
{
"title": "Real-time Analytics",
"caption": "Track performance instantly",
"summary": "Monitor your team's productivity with live dashboards and insights",
"screenshot": {
"caption": "Analytics dashboard",
"imageId": "b4c5d6e7-f8a9-0b1c-2d3e-567890123456"
},
"thumbnail": "f0a1b2c3-d4e5-6f7a-8b9c-234567890123"
},
{
"title": "Seamless Integration",
"caption": "Connect with your favorite tools",
"summary": "Integrate effortlessly with popular third-party applications and services",
"screenshot": {
"caption": "Integration configuration panel",
"imageId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
"thumbnail": "b2c3d4e5-f6a7-8901-bcde-f23456789012"
}
],
"moreDetails": "This version introduces enhanced project tracking capabilities, improved team collaboration tools, and advanced reporting features for better project management. Experience seamless integration with your existing workflows.",
"heroImage": "h1e2r3o4-i5m6-a7g8-e9u0-123456789abc",
"youtubeId": "dQw4w9WgXcQ",
"deploymentInstructions": [
{
"body": "Download and install the app from the Atlassian Marketplace by clicking the 'Get it now' button",
"screenshot": {
"caption": "Marketplace installation page",
"imageId": "a5b6c7d8-e9f0-1a2b-3c4d-567890abcdef"
}
},
{
"body": "Configure your project settings and invite team members to start collaborating",
"screenshot": {
"caption": "Initial setup configuration",
"imageId": "d2e3f4a5-b6c7-8d9e-0f1a-234567890123"
}
}
],
"developerLinks": {
"documentation": "https://docs.projectapp.com/v2",
"learnMore": "https://projectapp.com/features-v2",
"eula": "https://projectapp.com/license",
"purchase": "https://marketplace.atlassian.com/apps/1234567/projectapp",
"bonTermsSupported": true,
"partnerSpecificTerms": "Custom partner terms and conditions apply"
},
"state": "PUBLIC"
}'Retrieves listing information for multiple versions of the specified app software. Supports pagination via limit and cursor, and optional filtering by state (PUBLIC, PRIVATE) and approvalStatus (APPROVED, SUBMITTED, REJECTED, UNINITIATED).
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredinteger
string
string
string
Successfully retrieved app software versions listing
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/marketplace/rest/3/app-software/{appSoftwareId}/listings/all' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
{
"links": {
"self": "/rest/3/app-software/a1b2c3d4-e5f6-7890-abcd-ef1234567890/listings/all?limit=10",
"next": "/rest/3/app-software/a1b2c3d4-e5f6-7890-abcd-ef1234567890/listings/all?limit=10&cursor=eyJ2ZXJzaW9uSWQiOiJhYmNkZWZnaC0xMjM0LTU2NzgtOTBhYi1jZGVmZ2hpams="
},
"versions": [
{
"screenshots": [
{
"caption": "Main dashboard with analytics overview",
"imageId": "c7d8e9f0-a1b2-3c4d-5e6f-123456789abc"
},
{
"caption": "Configuration panel for settings",
"imageId": "f3a4b5c6-d7e8-9f0a-1b2c-456789abcdef"
},
{
"caption": "Integration setup wizard",
"imageId": "b9c0d1e2-f3a4-5b6c-7d8e-789012345678"
}
],
"highlights": [
{
"title": "Easy Setup",
"caption": "Quick and simple installation process",
"summary": "Get started in minutes with our guided setup",
"screenshot": {
"caption": "Setup wizard interface",
"imageId": "e5f6a7b8-c9d0-1e2f-3a4b-901234567890"
},
"thumbnail": "a1b2c3d4-e5f6-7a8b-9c0d-234567890123"
},
{
"title": "Advanced Analytics",
"caption": "Powerful reporting and insights",
"summary": "Track performance with detailed metrics",
"screenshot": {
"caption": "Analytics dashboard",
"imageId": "d7e8f9a0-b1c2-3d4e-5f6a-567890123456"
},
"thumbnail": "c3d4e5f6-a7b8-9c0d-1e2f-890123456789"
},
{
"title": "Team Collaboration",
"caption": "Enhanced team communication tools",
"summary": "Improve team productivity with integrated collaboration features",
"screenshot": {
"caption": "Team collaboration workspace",
"imageId": "f9a0b1c2-d3e4-5f6a-7b8c-678901234567"
},
"thumbnail": "b5c6d7e8-f9a0-1b2c-3d4e-901234567890"
}
],
"moreDetails": "This app provides comprehensive project management tools with seamless integration capabilities. Key features include real-time collaboration, automated workflows, and detailed reporting.",
"heroImage": "h7e8r9o0-i1m2-a3g4-e5u6-456789012345",
"youtubeId": "abc123XYZ89",
"deploymentInstructions": [
{
"body": "1. Install the app from the Marketplace",
"screenshot": {
"caption": "Installation screen",
"imageId": "f9a0b1c2-d3e4-5f6a-7b8c-012345678901"
}
},
{
"body": "2. Configure basic settings in admin panel",
"screenshot": {
"caption": "Admin configuration",
"imageId": "b5c6d7e8-f9a0-1b2c-3d4e-345678901234"
}
},
{
"body": "3. Set up user permissions and test functionality",
"screenshot": {}
}
],
"developerLinks": {
"documentation": "https://docs.example.com/app-guide",
"learnMore": "https://example.com/features",
"eula": "https://example.com/license",
"purchase": "https://marketplace.atlassian.com/apps/example",
"bonTermsSupported": true,
"partnerSpecificTerms": "Custom partner terms and conditions apply"
},
"approvalStatus": "APPROVED",
"state": "PUBLIC",
"approvalDetails": {
"issueKey": "MKPLHELP-12345",
"approvalDate": "2023-08-15T10:30:00.000Z",
"submittedDate": "2023-08-10T14:20:00.000Z",
"approvedBy": "admin@example.com"
},
"buildNumber": 67890,
"appSoftwareId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"revision": 3
},
{
"screenshots": [
{
"caption": "Beta preview interface",
"imageId": "a3b4c5d6-e7f8-9a0b-1c2d-678901234567"
},
{
"caption": "New feature demonstration",
"imageId": "e7f8a9b0-c1d2-3e4f-5a6b-012345678901"
}
],
"highlights": [
{
"title": "Beta Features",
"caption": "Early access to upcoming functionality",
"summary": "Test new features before general release",
"screenshot": {
"caption": "Beta feature preview",
"imageId": "c1d2e3f4-a5b6-7c8d-9e0f-456789012345"
},
"thumbnail": "f5a6b7c8-d9e0-1f2a-3b4c-789012345678"
},
{
"title": "Experimental UI",
"caption": "New user interface design",
"summary": "Experience the next generation interface with improved usability",
"screenshot": {
"caption": "New UI design preview",
"imageId": "e3f4a5b6-c7d8-9e0f-1a2b-567890123456"
},
"thumbnail": "a7b8c9d0-e1f2-3a4b-5c6d-890123456789"
},
{
"title": "Performance Enhancements",
"caption": "Faster processing and response times",
"summary": "Optimized algorithms for improved performance and efficiency",
"screenshot": {
"caption": "Performance metrics dashboard",
"imageId": "b5c6d7e8-f9a0-1b2c-3d4e-678901234567"
},
"thumbnail": "d9e0f1a2-b3c4-5d6e-7f8a-012345678901"
}
],
"moreDetails": "Beta version with experimental features for testing and feedback collection.",
"heroImage": "h3e4r5o6-i7m8-a9g0-e1u2-789012345678",
"youtubeId": "beta456ABC12",
"deploymentInstructions": [
{
"body": "1. Enable beta testing in account settings",
"screenshot": {}
},
{
"body": "2. Install beta version and provide feedback",
"screenshot": {}
}
],
"developerLinks": {
"documentation": "https://docs.example.com/beta",
"learnMore": "https://example.com/beta-program",
"eula": "https://example.com/license",
"purchase": "https://marketplace.atlassian.com/apps/example",
"bonTermsSupported": false,
"partnerSpecificTerms": "Beta version - standard terms apply"
},
"approvalStatus": "SUBMITTED",
"state": "PRIVATE",
"approvalDetails": {
"issueKey": "MKPLHELP-67890",
"submittedDate": "2023-09-01T11:45:00.000Z"
},
"buildNumber": 54321,
"appSoftwareId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"revision": 1
}
]
}Rate this page: