apps
latest
false
important :
For documentation on app projects in Studio Web, refer to the App Projects chapter in the Studio Web documentation: https://docs.uipath.com/studio-web/automation-cloud/latest/user-guide/apps-in-studio-web.
Apps API guide
Retrieves all deployed apps in a folder.
API endpoint
GET <BaseURL>/models/deployed/apps
See Base URL for the root endpoint path.
Request headers
| Header | Value |
|---|---|
| Authorization | Bearer <access_token> |
| X-UiPath-Internal-TenantId | <tenant_id> |
| X-UiPath-FolderKey | <folder_key> |
Note:
Replace all the values between the angle brackets <...> with their corresponding use-case values.
The <access_token> is the one you received when you authorized the external application with the Apps or Apps.Read scope. It is available for 1 hour, then you need to generate a new one, or request a refresh token.
Query parameters
| Query parameter | Data type | Description | Default value |
|---|---|---|---|
| top (optional) | int32 | The number of results to return. | N/A |
| skip (optional) | int32 | The number of results to skip. | N/A |
| orderBy (optional) | string | The field to order results by. | N/A |
| searchText (optional) | string | Filters results by the specified search text. | N/A |
| tags (optional) | string | Comma-separated list of system tag values to filter by. | N/A |
Responses
200 OK
{
"@odata.context": "string",
"@odata.count": 1,
"value": [
{
"id": "string",
"appSystemName": "string",
"title": "string",
"description": "string",
"version": 1,
"routingName": "string",
"tags": ["string"]
}
]
}
{
"@odata.context": "string",
"@odata.count": 1,
"value": [
{
"id": "string",
"appSystemName": "string",
"title": "string",
"description": "string",
"version": 1,
"routingName": "string",
"tags": ["string"]
}
]
}
| Field | Data type | Description |
|---|---|---|
| @odata.context | string | The OData context URL. |
| @odata.count | number | The total number of deployed apps matching the query. |
| value | array | The list of deployed apps. |
| value[].id | string | The deployment ID of the app. |
| value[].appSystemName | string | The system name of the app. |
| value[].title | string | The display title of the deployed app. |
| value[].description | string | The description of the deployed app. |
| value[].version | number | The deployed version number. |
| value[].routingName | string | The routing name used in the app URL. |
| value[].tags | string[] | The system tag values attached to the deployed app. |
401 Unauthorized
You are not authenticated. Make sure you are using a valid access token with the Apps or Apps.Read scope.
403 Forbidden
You don't have permission to view deployed apps in the specified folder.