Apps And Solutions
Application
Get Application By Listing ID
1min
GET
/developer/apps
This API is used to get application details by listingId.
Header Parameters
x-developerplatform-access
string
*
Query Parameters
listingId
string
*
Responses
200
AppDTO
appId
string
listingId
string
*
urn
string
*
uniqueName
string
*
urlPath
string
*
appType
string<WEB | MOBILE | BACKEND>
*
isSubscriptionCredentialsAvailable
boolean
*
clients
AppClientDTO[]
*
classifications
string<CORE | STANDARD | ADDON | CONFIGURATION>
*
versions
AppVersionDTO[]
*
403
User does not have access to the app's org/team combo
ForbiddenErrorResponseDTO
error
ForbiddenErrorDTO
*
request
StandardRequestDTO
*
404
App not found based on provided listing id
NotFoundErrorResponseDTO
error
NotFoundErrorDTO
*
request
StandardRequestDTO
*
Curl
JS
Ruby
Python
1curl --location '/developer/apps?listingId=string' \
2--header 'Accept: application/json' \
3--header 'Content-Type: application/json'
Responses
200
403
404
1{
2 "appId": "app:bf17e158-1951-47f9-84f1-e50aeb59fac2",
3 "listingId": "vehicle-tracker-genius",
4 "urn": "platform:app:bf17e158-1951-47f9-84f1-e50aeb59fac2",
5 "uniqueName": "vehicles",
6 "urlPath": "vehicles",
7 "appType": "",
8 "isSubscriptionCredentialsAvailable": false,
9 "clients": [
10 {
11 "environment": "",
12 "clientKey": "platform:app:client:bf17e158-1951-47f9-84f1-e50aeb59fac2",
13 "serviceKey": "platform:app:service:bf17e158-1951-47f9-84f1-e50aeb59fac2",
14 "secret": "bf17e158-1951-47f9-84f1-e50aeb59fac2"
15 }
16 ],
17 "classifications": "1.0.0",
18 "versions": [
19 {
20 "createdAt": "",
21 "createdBy": "",
22 "updatedAt": "",
23 "updatedBy": "",
24 "appId": "app:bf17e158-1951-47f9-84f1-e50aeb59fac2",
25 "appVersionId": "appversion:bf17e158-1951-47f9-84f1-e50aeb59fac2",
26 "version": "1.0.0",
27 "displayName": "Vehicles",
28 "description": "This is a very long description of the app",
29 "visibility": {},
30 "isConsoleCompatible": false,
31 "consoleCompatible": false,
32 "isMarketplaceCompatible": false,
33 "status": "DEVELOPMENT",
34 "state": {},
35 "appUrls": [
36 {
37 "name": "interface",
38 "url": "https://mytenant.os1.delhivery.com/my-app"
39 }
40 ],
41 "packageName": [
42 {
43 "name": "interface",
44 "url": "https://mytenant.os1.delhivery.com/my-app"
45 }
46 ],
47 "urlOverrides": [
48 {
49 "stackId": "logistax",
50 "url": {}
51 }
52 ],
53 "icons": [
54 {
55 "artifactId": "470d7bb7-4136-4fa5-8806-85d5f7ee2548",
56 "fileName": "icon.png",
57 "fileDescription": "",
58 "fileUrl": "https://my-app.com/icon.png",
59 "filePath": "myapp/icon.png"
60 }
61 ],
62 "settingsIcon": {},
63 "images": [
64 {
65 "artifactId": "470d7bb7-4136-4fa5-8806-85d5f7ee2548",
66 "fileName": "icon.png",
67 "fileDescription": "",
68 "fileUrl": "https://my-app.com/icon.png",
69 "filePath": "myapp/icon.png"
70 }
71 ],
72 "shortDescription": "This is a short description of the app",
73 "longDescription": "This is a very long description of the app",
74 "categories": [
75 [
76 ""
77 ]
78 ],
79 "documents": [
80 {
81 "category": "DRAFT",
82 "document": {}
83 }
84 ],
85 "permissions": [
86 {
87 "artifactId": "470d7bb7-4136-4fa5-8806-85d5f7ee2548",
88 "fileName": "icon.png",
89 "fileDescription": "",
90 "fileUrl": "https://my-app.com/icon.png",
91 "filePath": "myapp/icon.png"
92 }
93 ],
94 "permissionsWeb": [
95 {
96 "artifactId": "470d7bb7-4136-4fa5-8806-85d5f7ee2548",
97 "fileName": "icon.png",
98 "fileDescription": "",
99 "fileUrl": "https://my-app.com/icon.png",
100 "filePath": "myapp/icon.png"
101 }
102 ],
103 "applicationMenu": [
104 {
105 "id": "470d7bb7-4136-4fa5-8806-85d5f7ee2548",
106 "parentId": "470d7bb7-4136-4fa5-8806-85d5f7ee2548",
107 "displayName": "Create Order",
108 "displayOrder": 1,
109 "relativePath": "/my-app/create-order",
110 "icon": {}
111 }
112 ],
113 "compatibleSolution": [
114 {
115 "solutionId": "solution:b31414f1-bc40-42c9-bcc0-ed7a47126441"
116 }
117 ]
118 }
119 ]
120}
Updated 10 Oct 2024
Did this page help you?