GET Folders
GET {{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/orchestrator_/odata/folders
It is recommended that the user should specify the Fully Qualified Name of the folder. Once specified, it can be passed in the header X-UIPATH-FolderPath for API calls that need the header.
From a connector perspective, if folders are being used in the Orchestrator tenant, then some API calls that consume resources from a folder will require the folder name be passed in as a header. If a folder is not specified, then the API call is assumed to be for the modern folder named Shared (which always exists), and the call will fail if the required automations/resources are not available in that folder. If a API expects a folder to be specified and one is not specified, then the call will fail with the HTTP Error Code 400 as follows:
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
$Filter | string |
RESPONSES
status: OK
{"@odata.context":"https://cloud.uipath.com/org/tenat/orchestrator_/odata/$metadata#Folders","@odata.count":1,"value":[{"Key":"db4528cc-7a3d-44f0-9df9-781fc07e9d8d","DisplayName":"Shared","FullyQualifiedName":"Shared","FullyQualifiedNameOrderable":"Shared","Description":null,"ProvisionType":"Automatic","PermissionModel":"FineGrained","ParentId":null,"ParentKey":null,"IsActive":true,"FeedType":"Processes","Id":515116}]}