---
title: "Return cPanel accounts with server name and type"
method: GET
path: "/list_user_child_nodes"
tags: ["Server Administration", "Server Nodes"]
---

# Return cPanel accounts with server name and type

`GET /list_user_child_nodes`

This function returns the system's cPanel accounts and the [linked cPanel & WHM server](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles) on which they exist.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `payload` object[] — A list of cPanel accounts and the linked cPanel & WHM servers on which they exist.
      - `alias` string — The name (alias) of the linked cPanel & WHM server.
      - `type` 'Mail' — The linked [cPanel & WHM server's profile](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles). * `Mail` - A server set as a mail node.
      - `user` string — The cPanel account username.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` — Success. * `0` — Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

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