orchestrator
latest
false
- Getting Started
- Swagger Definition
- Orchestrator APIs- Alerts Requests
- Assets Requests
- Calendars Requests
- Environments Requests
- Folders Requests
- Generic Tasks Requests
- Jobs Requests
- Libraries Requests
- License Requests
- Packages Requests
- Permissions Requests
- Personal Workspaces Requests
- Processes Requests
- Process Data Retention Policy Requests
- Queue Items Requests
- Queue Retention Policy Requests
- Robots Requests
- Roles Requests
- Schedules Requests
- Settings Requests
- Storage Bucket Requests
- Tasks Requests
- Task Catalogs Requests
- Task Forms Requests
- Tenants Requests
- Transactions Requests
- Users Requests
- Webhooks Requests
 

Orchestrator API Guide
Last updated Nov 25, 2024
The following request enables you to retrieve the list of personal workspaces in a tenant and their details, such as the ID of each personal workspace:
GET
https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/PersonalWorkspaces
Request headers
| Key | Value | 
|---|---|
| Authorization | Bearer | 
Response code
200 OK
Response body
{
    "@odata.context": "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#PersonalWorkspaces",
    "@odata.count": 2,
    "value": [
        {
            "Key": "af5277d6-63a6-43e6-9731-64b0d7c6c601",
            "Name": "[email protected]'s workspace",
            "IsActive": true,
            "OwnerId": 1475514,
            "OwnerName": "[email protected]",
            "LastLogin": "2022-03-08T17:24:03.23Z",
            "ExploringUserIds": [],
            "Id": 620795
        },
        {
            "Key": "3af82603-161e-4c0a-a955-4d625a084716",
            "Name": "[email protected]'s workspace",
            "IsActive": true,
            "OwnerId": 2346675,
            "OwnerName": "[email protected]",
            "LastLogin": "2022-09-19T15:38:14.157Z",
            "ExploringUserIds": [],
            "Id": 3731674
        }
    ]
}{
    "@odata.context": "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#PersonalWorkspaces",
    "@odata.count": 2,
    "value": [
        {
            "Key": "af5277d6-63a6-43e6-9731-64b0d7c6c601",
            "Name": "[email protected]'s workspace",
            "IsActive": true,
            "OwnerId": 1475514,
            "OwnerName": "[email protected]",
            "LastLogin": "2022-03-08T17:24:03.23Z",
            "ExploringUserIds": [],
            "Id": 620795
        },
        {
            "Key": "3af82603-161e-4c0a-a955-4d625a084716",
            "Name": "[email protected]'s workspace",
            "IsActive": true,
            "OwnerId": 2346675,
            "OwnerName": "[email protected]",
            "LastLogin": "2022-09-19T15:38:14.157Z",
            "ExploringUserIds": [],
            "Id": 3731674
        }
    ]
}The following request enables you to convert the personal workspace with the ID 2142812 into a modern folder with the name
                  "FinanceAutomationsJohn". To retrieve the ID of a personal workspace, make a GET request to the 
               
               /odata/PersonalWorkspaces endpoint.
               POST
https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/PersonalWorkspaces(2142812)/UiPath.Server.Configuration.OData.ConvertToFolder
Request headers
| Key | Value | 
|---|---|
| Authorization | Bearer | 
Request body
{
  "folderName": "FinanceAutomationsJohn"
}{
  "folderName": "FinanceAutomationsJohn"
}Response code
204 No Content