# Return task queue information

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.

Git Version Control*
interface () uses the user task queue
to clone repositories (via the  function).
* For more information, read our
Task Queue Monitor documentation.

Endpoint: GET /UserTasks/retrieve
Version: 11.134.0.5
Security: BasicAuth

## Response 200 fields (application/json):

  - `apiversion` (integer)
    The version of the API.
    Example: 3

  - `func` (string)
    The name of the method called.
    Example: "retrieve"

  - `module` (string)
    The name of the module called.
    Example: "UserTasks"

  - `result` (object)

  - `result.data` (array)
    An array of objects containing data for a task in the user task queue.
    Example: [{"action":"create","args":{},"id":"00000000\\/5a9ec8dd4c345d","subsystem":"VersionControl"},{"action":"create","args":{"repository_root":"/home/user/public_html/example"},"id":"00000000/h39dnn27suc13l","subsystem":"VersionControl"}]

  - `result.data.action` (string)
    The task's action.

* 



 is the only possible value.
    Enum: "create"

  - `result.data.args` (object)
    An object containing one or more action- and subsystem-specific
arguments, if any exist.

For example, a task that returns an  value of  and
a  value of  will include the
 argument.

  - `result.data.args.repository_root` (string)
    The absolute path to the repostiory's  directory.

  - `result.data.id` (string)
    The task's ID number.
    Example: "00000000\\/5a9ec8dd4c345d"

  - `result.data.subsystem` (string)
    The subsystem that will handle the process.

* 



 is the only possible value.
    Enum: "VersionControl"

  - `result.errors` (array,null)
    List of errors if the API failed.

  - `result.messages` (array,null)
    List of messages generated by the API.

  - `result.metadata` (object)

  - `result.metadata.transformed` (integer)
    Post-processing may have transformed the data.
    Enum: 1

  - `result.status` (integer)
    *  — Success.
*  — Failed. Check the  field for more details.
    Enum: 1, 0

  - `result.warnings` (array,null)
    List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.