Sign in

632e2f8e6d04

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
UserManager
Subaccount Management

Return Subaccount's information

This function lists a single Subaccount's information.

get/UserManager/lookup_user

Query parameters

guidstring required
Example:EXAMPLE1:EXAMPLE.COM:564CD663%3AFE50072F2620B50988EA4E5F46022546FBE6BDDE3C36C2F2534F4967C661EC37

The Subaccount's unique identifier.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "lookup_user",
  "module": "UserManager",
  "result": {
    "data": {
      "alternate_email": "user@example.com",
      "avatar_url": "https://img.example.com/avatars/example.jpg",
      "can_set_password": 1,
      "dismissed": 1,
      "domain": "example.com",
      "full_username": "user@example.com",
      "guid": "N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4",
      "issues": [
        {
          "area": "quota",
          "limit": 1500,
          "message": "Your account is over quota.",
          "service": "email",
          "type": "info",
          "used": 2000
        }
      ],
      "merge_candidates": [
        {
          "alternate_email": "user@example.com",
          "avatar_url": "https://img.example.com/avatars/example.jpg",
          "can_set_password": 1,
          "dismissed": 1,
          "domain": "example.com",
          "full_username": "user@example.com",
          "guid": "N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4",
          "issues": [
            {
              "area": "quota",
              "limit": 1500,
              "message": "Your account is over quota.",
              "service": "email",
              "type": "info",
              "used": 2000
            }
          ],
          "parent_type": "hypothetical",
          "phone_number": "+15551234567",
          "real_name": "John Doe",
          "services": {
            "email": {
              "enabled": 1,
              "quota": 100
            },
            "ftp": {
              "homedir": "/subaccount",
              "quota": 100
            },
            "special": 1,
            "webdisk": {
              "homedir": "/bob",
              "perms": "rw"
            }
          },
          "type": "sub",
          "username": "example"
        }
      ],
      "parent_type": "hypothetical",
      "phone_number": "+15551234567",
      "real_name": "John Doe",
      "services": {
        "email": {
          "enabled": 1,
          "quota": 100
        },
        "ftp": {
          "homedir": "/subaccount",
          "quota": 100
        },
        "special": 1,
        "webdisk": {
          "homedir": "/bob",
          "perms": "rw"
        }
      },
      "type": "sub",
      "username": "example",
      "dismissed_merge_candidates": [
        {
          "alternate_email": "user@example.com",
          "avatar_url": "https://img.example.com/avatars/example.jpg",
          "can_set_password": 1,
          "dismissed": 1,
          "domain": "example.com",
          "full_username": "user@example.com",
          "guid": "N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4",
          "issues": [
            {
              "area": "quota",
              "limit": 1500,
              "message": "Your account is over quota.",
              "service": "email",
              "type": "info",
              "used": 2000
            }
          ],
          "parent_type": "hypothetical",
          "phone_number": "+15551234567",
          "real_name": "John Doe",
          "services": {
            "email": {
              "enabled": 1,
              "quota": 100
            },
            "ftp": {
              "homedir": "/subaccount",
              "quota": 100
            },
            "special": 1,
            "webdisk": {
              "homedir": "/bob",
              "perms": "rw"
            }
          },
          "type": "sub",
          "username": "example"
        }
      ],
      "invite_expiration": 1591718154
    },
    "status": 1
  }
}