Apps And Solutions
Common
Get all applications for a given organization.
1min
GET
/developer/organization/{orgId}/apps
This is an api for retrieving all the applications owned by the provided organization with ability to filter by a specific team. Returns empty array if no applications are found.
Path Parameters
orgId
string
*
Header Parameters
x-developerplatform-access
string
*
Query Parameters
teamId
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[]
*
400
User not authorized on the org/team id combination.
BadRequestErrorResponseDTO
error
BadRequestErrorDTO
*
request
StandardRequestDTO
*
Curl
JS
Ruby
Python
1curl --location --globoff '/developer/organization/{orgId}/apps' \
2--header 'Accept: application/json' \
3--header 'Content-Type: application/json'
Responses
200
400
1[
2 {
3 "appId": "app:bf17e158-1951-47f9-84f1-e50aeb59fac2",
4 "listingId": "vehicle-tracker-genius",
5 "urn": "platform:app:bf17e158-1951-47f9-84f1-e50aeb59fac2",
6 "uniqueName": "vehicles",
7 "urlPath": "vehicles",
8 "appType": "",
9 "isSubscriptionCredentialsAvailable": false,
10 "clients": [
11 {
12 "environment": "",
13 "clientKey": "platform:app:client:bf17e158-1951-47f9-84f1-e50aeb59fac2",
14 "serviceKey": "platform:app:service:bf17e158-1951-47f9-84f1-e50aeb59fac2",
15 "secret": "bf17e158-1951-47f9-84f1-e50aeb59fac2"
16 }
17 ],
18 "classifications": "1.0.0",
19 "versions": [
20 {
21 "createdAt": "",
22 "createdBy": "",
23 "updatedAt": "",
24 "updatedBy": "",
25 "appId": "app:bf17e158-1951-47f9-84f1-e50aeb59fac2",
26 "appVersionId": "appversion:bf17e158-1951-47f9-84f1-e50aeb59fac2",
27 "version": "1.0.0",
28 "displayName": "Vehicles",
29 "description": "This is a very long description of the app",
30 "visibility": {},
31 "isConsoleCompatible": false,
32 "consoleCompatible": false,
33 "isMarketplaceCompatible": false,
34 "status": "DEVELOPMENT",
35 "state": {},
36 "appUrls": [
37 {
38 "name": "interface",
39 "url": "https://mytenant.os1.delhivery.com/my-app"
40 }
41 ],
42 "packageName": [
43 {
44 "name": "interface",
45 "url": "https://mytenant.os1.delhivery.com/my-app"
46 }
47 ],
48 "urlOverrides": [
49 {
50 "stackId": "logistax",
51 "url": {}
52 }
53 ],
54 "icons": [
55 {
56 "artifactId": "470d7bb7-4136-4fa5-8806-85d5f7ee2548",
57 "fileName": "icon.png",
58 "fileDescription": "",
59 "fileUrl": "https://my-app.com/icon.png",
60 "filePath": "myapp/icon.png"
61 }
62 ],
63 "settingsIcon": {},
64 "images": [
65 {
66 "artifactId": "470d7bb7-4136-4fa5-8806-85d5f7ee2548",
67 "fileName": "icon.png",
68 "fileDescription": "",
69 "fileUrl": "https://my-app.com/icon.png",
70 "filePath": "myapp/icon.png"
71 }
72 ],
73 "shortDescription": "This is a short description of the app",
74 "longDescription": "This is a very long description of the app",
75 "categories": [
76 [
77 ""
78 ]
79 ],
80 "documents": [
81 {
82 "category": "DRAFT",
83 "document": {}
84 }
85 ],
86 "permissions": [
87 {
88 "artifactId": "470d7bb7-4136-4fa5-8806-85d5f7ee2548",
89 "fileName": "icon.png",
90 "fileDescription": "",
91 "fileUrl": "https://my-app.com/icon.png",
92 "filePath": "myapp/icon.png"
93 }
94 ],
95 "permissionsWeb": [
96 {
97 "artifactId": "470d7bb7-4136-4fa5-8806-85d5f7ee2548",
98 "fileName": "icon.png",
99 "fileDescription": "",
100 "fileUrl": "https://my-app.com/icon.png",
101 "filePath": "myapp/icon.png"
102 }
103 ],
104 "applicationMenu": [
105 {
106 "id": "470d7bb7-4136-4fa5-8806-85d5f7ee2548",
107 "parentId": "470d7bb7-4136-4fa5-8806-85d5f7ee2548",
108 "displayName": "Create Order",
109 "displayOrder": 1,
110 "relativePath": "/my-app/create-order",
111 "icon": {}
112 }
113 ],
114 "compatibleSolution": [
115 {
116 "solutionId": "solution:b31414f1-bc40-42c9-bcc0-ed7a47126441"
117 }
118 ]
119 }
120 ]
121 }
122]


Updated 10 Oct 2024
Did this page help you?