---
title: "Return task queue information"
method: GET
path: "/UserTasks/retrieve"
tags: ["UserTasks", "SSE Task Management"]
---

# Return task queue information

`GET /UserTasks/retrieve`

This function retrieves a cPanel account's user task queue information.

Each cPanel account uses a separate user task queue in order to ensure that
processes for one user do not impede another user on the server.

* For example, the [*Git Version Control*](https://go.cpanel.net/GitVersionControl)
interface (*cPanel >> Home >> Files >> Git Version Control*) uses the user task queue
to clone repositories (via the `VersionControl::create` function).
* For more information, read our
[Task Queue Monitor](https://go.cpanel.net/whmdocsTaskQueueMonitor) documentation.

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object[] — An array of objects containing data for a task in the user task queue.
      - `action` 'create' — The task's action. * `create` **Note:** `create` is the only possible value.
      - `args` object — An object containing one or more action- and subsystem-specific arguments, if any exist. For example, a task that returns an `action` value of `create` and a `subsystem` value of `VersionControl` will include the `repository_root` argument.
        - `repository_root` string — The absolute path to the repostiory's `root` directory.
      - `id` string — The task's ID number.
      - `subsystem` 'VersionControl' — The subsystem that will handle the process. * `VersionControl` **Note:** `VersionControl` is the only possible value.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
      - `transformed` 1 — Post-processing may have transformed the data.
    - `status` 1 | 0 — * `1` — Success. * `0` — Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)