Return cPanel account's Subaccounts

This function lists the cPanel account's Subaccounts.

SecurityBasicAuth

Request

query Parameters

flat	integer Default: 0 Whether to return Subaccounts with the same name under the merge_candidates array. `1` - Do not return. `0` - Return. Enum: 0 1 Example: flat=0

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/UserManager/list_users

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  UserManager \
  list_users

Response samples

application/json

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