orchestrator
latest
false
UiPath logo, featuring letters U and I in white

Orchestrator API guide

Last updated Dec 15, 2025

App Tasks requests

Requesting App Tasks

Use the following endpoints to retrieve App Task metadata and status information.

You can request App Tasks using either the ID or the Key returned when creating or listing tasks.

According to App Task ID

Retrieve an App Task using its ID.

GET

https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/tasks/AppTasks/GetAppTaskById

Request headers
KeyValue
AuthorizationBearer
Response code

200 Success

Response body
{
  "id": 58293,
  "key": "7b847a63-b4db-4c0a-a256-afd3b70f729f",
  "title": "Approve Purchase Request",
  "status": "Pending",
  "priority": "Normal",
  "type": "AppTask",
  "appTasksMetadata": {
    "appId": "myapp-12345",
    "appVersion": 3,
    "creationTime": "2024-01-11T10:20:30Z",
    "id": 58293
  }
}
{
  "id": 58293,
  "key": "7b847a63-b4db-4c0a-a256-afd3b70f729f",
  "title": "Approve Purchase Request",
  "status": "Pending",
  "priority": "Normal",
  "type": "AppTask",
  "appTasksMetadata": {
    "appId": "myapp-12345",
    "appVersion": 3,
    "creationTime": "2024-01-11T10:20:30Z",
    "id": 58293
  }
}

According to App Task key

Retrieve an App Task using its unique key.

GET

https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/tasks/AppTasks/GetAppTaskByKey

Request headers
KeyValue
AuthorizationBearer
Response code

200 Success

Response body
{
  "id": 58293,
  "key": "7b847a63-b4db-4c0a-a256-afd3b70f729f",
  "title": "Approve Purchase Request",
  "status": "Pending",
  "priority": "Normal",
  "type": "AppTask",
  "appTasksMetadata": {
    "appId": "myapp-12345",
    "appVersion": 3,
    "creationTime": "2024-01-11T10:20:30Z",
    "id": 58293
  }
}
{
  "id": 58293,
  "key": "7b847a63-b4db-4c0a-a256-afd3b70f729f",
  "title": "Approve Purchase Request",
  "status": "Pending",
  "priority": "Normal",
  "type": "AppTask",
  "appTasksMetadata": {
    "appId": "myapp-12345",
    "appVersion": 3,
    "creationTime": "2024-01-11T10:20:30Z",
    "id": 58293
  }
}

Create a new App Task

Use this endpoint to create a new App Task based on a previously-deployed App and Task Definition.

GET

https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/tasks/AppTasks/CreateAppTask

Request headers

KeyValue
AuthorizationBearer

Response code

201 Created

Request body

{
  "appId": "myapp-12345",
  "appVersion": 3,
  "folderKey": "folder-12345-678910",
  "fpsContext": (),
  "runtime": "Serverless",
  "appType": "Custom",
  "appProcessKey": "key123-4567-8910",
  "isActionableMessageEnabled": false,
  "title": "Approve Purchase Request",
  "type": "AppTask",
  "title": "string",
  "priority": "Normal",
  "data": {
    "Amount": 2450,
    "Requester": "John Doe"
  }
}
{
  "appId": "myapp-12345",
  "appVersion": 3,
  "folderKey": "folder-12345-678910",
  "fpsContext": (),
  "runtime": "Serverless",
  "appType": "Custom",
  "appProcessKey": "key123-4567-8910",
  "isActionableMessageEnabled": false,
  "title": "Approve Purchase Request",
  "type": "AppTask",
  "title": "string",
  "priority": "Normal",
  "data": {
    "Amount": 2450,
    "Requester": "John Doe"
  }
}

Response body

{
    "taskDefinitionPropertiesId": null,
    "appTasksMetadata": null,
    "actionLabel": null,
    "status": 0,
    "data": null,
    "action": null,
    "waitJobState": null,
    "organizationUnitFullyQualifiedName": null,
    "tags": [],
    "assignedToUser": null,
    "taskSlaDetails": null,
    "completedByUser": null,
    "taskAssignmentCriteria": "SingleUser",
    "taskAssignees": null,
    "isCurrentUserInAllUserAssignedGroup": null,
    "taskSource": null,
    "processingTime": null,
    "title": "string",
    "type": "AppTask",
    "priority": "Low",
    "assignedToUserId": null,
    "assignedToUserKey": null,
    "organizationUnitId": 1,
    "organizationUnitKey": "key-12345",
    "externalTag": null,
    "creatorJobKey": "00000000-0000-0000-0000-000000000000",
    "waitJobKey": null,
    "lastAssignedTime": null,
    "completionTime": null,
    "parentOperationId": null,
    "key": "f1ac-12345",
    "isDeleted": false,
    "deleterUserId": null,
    "deletionTime": null,
    "lastModificationTime": null,
    "lastModifierUserId": null,
    "creationTime": "2025-12-11T09:23:05.9915069Z",
    "creatorUserId": "user-12345",
    "id": 12345
}{
    "taskDefinitionPropertiesId": null,
    "appTasksMetadata": null,
    "actionLabel": null,
    "status": 0,
    "data": null,
    "action": null,
    "waitJobState": null,
    "organizationUnitFullyQualifiedName": null,
    "tags": [],
    "assignedToUser": null,
    "taskSlaDetails": null,
    "completedByUser": null,
    "taskAssignmentCriteria": "SingleUser",
    "taskAssignees": null,
    "isCurrentUserInAllUserAssignedGroup": null,
    "taskSource": null,
    "processingTime": null,
    "title": "string",
    "type": "AppTask",
    "priority": "Low",
    "assignedToUserId": null,
    "assignedToUserKey": null,
    "organizationUnitId": 1,
    "organizationUnitKey": "key-12345",
    "externalTag": null,
    "creatorJobKey": "00000000-0000-0000-0000-000000000000",
    "waitJobKey": null,
    "lastAssignedTime": null,
    "completionTime": null,
    "parentOperationId": null,
    "key": "f1ac-12345",
    "isDeleted": false,
    "deleterUserId": null,
    "deletionTime": null,
    "lastModificationTime": null,
    "lastModifierUserId": null,
    "creationTime": "2025-12-11T09:23:05.9915069Z",
    "creatorUserId": "user-12345",
    "id": 12345
}
  • Requesting App Tasks
  • According to App Task ID
  • According to App Task key
  • Create a new App Task
  • Request headers
  • Response code
  • Request body
  • Response body

Was this page helpful?

Support and Services
Get The Help You Need
UiPath Academy
Learning RPA - Automation Courses
UiPath Forum
UiPath Community Forum
Uipath Logo
Trust and Security
Terms of Use
Privacy Policy
Cookies Policy
© 2005-2025 UiPath. All rights reserved.