Get Queues
Returns all queues the user has access to.
Playground
Code Example
HTTP Request
HTTP Response
Returns a list of all queue objects the user has access to.Get Queue by ID
Returns a queue by ID.
Playground
Code Example
HTTP Request
HTTP Response
Returns the queue object based on thequeueId specified.
Get Tasks
Returns tasks based on the filters provided in the body. If the body is an empty object, it returns all tasks the user has access to.
Playground
Code Example
HTTP Request
Request Body
The request body accepts an object containing filters to apply to the request for tasks. All properties are optional and the body can be passed as an empty object to return all tasks.| Property Name | Type | Required | Description |
|---|---|---|---|
| queueId | String | Optional | An array of queue ids. |
| displayType | String | Optional | An array of display types for tasks. Options are ENIGMA_FORM, EMAIL, UNKNOWN. |
| status | String | Optional | An array of statuses. Options are OPEN, COMPLETED, VOIDED. |
| assignedBy | String | Optional | An array of user ids corresponding to the user that assigned the task to. |
| assignedTo | String | Optional | An array of user ids corresponding to the user that the task was assigned to. |
| createdOn | DateTime | Optional | An array containing an array with two elements: a start datetime and and end datetime, which define the createdOn date range. E.g. [["2023-10-04T12:22:54.239Z","2024-01-02T13:22:54.239Z"]] |
| createdBy | String | Optional | An array of user ids corresponding to the user that created the task. |
| assignedOn | DateTime | Optional | An array containing an array with two elements: a start datetime and and end datetime, which define the assigedOn date range. |
| updatedOn | DateTime | Optional | An array containing an array with two elements: a start datetime and and end datetime, which define the updatedOn date range. |
| completedOn | DateTime | Optional | An array containing an array with two elements: a start datetime and and end datetime, which define the completedOn date range. |
| completedBy | String | Optional | An array of user ids corresponding to the user that completed the task. |
| orderByString | String | Optional | An array of strings corresponding to the properties from this body that the list of tasks should be ordered by. |
| version | String | Optional | An array version numbers to filter by |
HTTP Response
Returns a list of tasks.Get Task by ID
Returns a task by its id.
Playground
Code Example
HTTP Request
HTTP Response
Returns the task object based requested.Save Task Progress
Saves current task values given in the body, which contains the key value pairs for each input property of the task in question.
Playground
Code Example

HTTP Request
Request Body
The request body accepts an object containing key value pairs for each input property of the task in question.HTTP Response
The current saved state of the task.Complete Task
Completes the task with the values given in the body.
Playground
Code Example

HTTP Request
Request Body
The request body accepts an object containing key value pairs for each input property of the task in question.HTTP Response
The completed task.Transfer Task
Transfer a task to another queue.
Playground
Code Example
HTTP Request
HTTP Response
The transfered task.Transfer Task to Another User
Transfer a task to another User.
Playground
Code Example
HTTP Request
Request Body
The request body accepts an object containing an array of task ids, type and userId.HTTP Response
The transfered task.Void a Task
Void a task.
Playground
Code Example
HTTP Request
HTTP Response
The voided task.Update permissions
Update a queue’s user/group permissions.
Playground
Code Example
HTTP Request
HTTP Body
A array of user or group objects containing the updated permissions| Property Name | Type | Required | Description |
|---|---|---|---|
| id | String | Required | The user or group id. |
| permissions | String | Required | An array of permissions. The array can be empty (Removes an permissions). Options are ADMIN, SHARE, DELETE, WRITE, READ, CREATE_CONTENT, READ_CONTENT, UPDATE_CONTENT, DELETE_CONTENT, EXPORT, EXECUTE. |
| name | String | Required | The display name of the user or group. |
| type | String | Required | The type of entity. Options are USER or GROUP |