# Return service account's information This function lists a service account's information. Endpoint: GET /UserManager/lookup_service_account Version: 11.134.0.5 Security: BasicAuth ## Query parameters: - `full_username` (string, required) The full username for the system account. Example: "username@example.com" - `type` (string, required) The type of system account. * * * Enum: "email", "ftp", "webdisk" ## Response 200 fields (application/json): - `apiversion` (integer) The version of the API. Example: 3 - `func` (string) The name of the method called. Example: "lookup_service_account" - `module` (string) The name of the module called. Example: "UserManager" - `result` (object) - `result.data` (object) - `result.data.dismissed_merge_candidates` (array) An array of objects of service candidates that the system dismissed from merges. - `result.data.dismissed_merge_candidates.merge_candidates` (array) An array of objects that represents the service accounts that the system could merge for this subaccount. - `result.data.dismissed_merge_candidates.merge_candidates.alternate_email` (string) An alternate email address for the subaccount's user. Example: "user@example.com" - `result.data.dismissed_merge_candidates.merge_candidates.avatar_url` (string) The user's subaccount profile photo. Example: "https://img.example.com/avatars/example.jpg" - `result.data.dismissed_merge_candidates.merge_candidates.can_delete` (integer) Whether the cPanel account user can delete the subaccount. * - Can delete. * - delete. Enum: 0, 1 - `result.data.dismissed_merge_candidates.merge_candidates.can_set_password` (integer) Whether the cPanel account user can change the subaccount's password. * - Can change. * - change. The function returns a value for subaccounts that inherit their password from the cPanel account. Enum: 0, 1 - `result.data.dismissed_merge_candidates.merge_candidates.can_set_quota` (integer) Whether the cPanel account user can change the subaccount's disk usage quota. * - Can change. * - change. Enum: 0, 1 - `result.data.dismissed_merge_candidates.merge_candidates.dismissed` (integer) Whether the cPanel account user dismissed the merge prompt for the service account. service accounts return this value. * - Dismissed. * - Did dismiss. Enum: 0, 1 - `result.data.dismissed_merge_candidates.merge_candidates.domain` (string) The Subaccount user's associated domain. A domain that the cPanel account owns. Example: "example.com" - `result.data.dismissed_merge_candidates.merge_candidates.full_username` (string) The subaccount's username and domain name. Example: "user@example.com" - `result.data.dismissed_merge_candidates.merge_candidates.guid` (string) The subaccount unique identifier. Example: "N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4" - `result.data.dismissed_merge_candidates.merge_candidates.has_expired_invite` (integer) Whether an expired account login invitation exists. * - Expired account invitation exists. * - Expired account invitation does exist. Enum: 0, 1 - `result.data.dismissed_merge_candidates.merge_candidates.has_invite` (integer) Whether an account login invitation exists. * - Account invitation exists. * - Account invitation does exist. Enum: 0, 1 - `result.data.dismissed_merge_candidates.merge_candidates.has_siblings` (integer) Whether the service account shares a value with another service account. * - Shares. * - Does share. Enum: 0, 1 - `result.data.dismissed_merge_candidates.merge_candidates.invite_expiration` (integer) When the invitation expires. Example: 1591718154 - `result.data.dismissed_merge_candidates.merge_candidates.issues` (array) Information about any issues or problems with the subaccount. - `result.data.dismissed_merge_candidates.merge_candidates.issues.area` (string) The affected section of cPanel & WHM. Example: "quota" - `result.data.dismissed_merge_candidates.merge_candidates.issues.limit` (integer) The set quota megabyte (MB) limit for the affected subaccount. Example: 1500 - `result.data.dismissed_merge_candidates.merge_candidates.issues.message` (string) The description of the issue. Example: "Your account is over quota." - `result.data.dismissed_merge_candidates.merge_candidates.issues.service` (string) The affected service. * * * Enum: "email", "ftp", "webdisk" - `result.data.dismissed_merge_candidates.merge_candidates.issues.type` (string) The type of issue. * * * Enum: "error", "warning", "info" - `result.data.dismissed_merge_candidates.merge_candidates.issues.used` (integer) The number of megabytes (MB) that the account currently uses. Example: 2000 - `result.data.dismissed_merge_candidates.merge_candidates.parent_type` (string) The type of account that could own the service account. * - A subaccount. * - A hypothetical subaccount that does yet exist, but the user could create as part of a merge. * - a merge candidate. Example: "hypothetical" - `result.data.dismissed_merge_candidates.merge_candidates.phone_number` (string) The subaccount user's phone number. The number conforms to the [ITU-T](https://en.wikipedia.org/wiki/ITU-T)'s [E.164](https://en.wikipedia.org/wiki/E.164)-recommended standard for the representation of telephone numbers. Example: "+15551234567" - `result.data.dismissed_merge_candidates.merge_candidates.real_name` (string) The name of the subaccount's user. * A first name, a last name, or a first name and last name. * An empty string. Example: "John Doe" - `result.data.dismissed_merge_candidates.merge_candidates.services` (object) This object contains information about the subaccount's access to email, FTP, and Web Disk. - `result.data.dismissed_merge_candidates.merge_candidates.services.email` (object) This object contains the information that indicates the subaccount's email status. - `result.data.dismissed_merge_candidates.merge_candidates.services.email.enabled` (integer) Whether the subaccount can access Webmail, POP, and IMAP services. * - Can access. * - access. Enum: 0, 1 - `result.data.dismissed_merge_candidates.merge_candidates.services.email.quota` (integer) The maximum amount of disk space, in megabytes (MB), allocated to the subaccount's email account. This function will not return as a value. Example: 100 - `result.data.dismissed_merge_candidates.merge_candidates.services.ftp` (object) This object contains the information that indicates the subaccount's FTP status. - `result.data.dismissed_merge_candidates.merge_candidates.services.ftp.enabled` (integer) Whether the subaccount can access FTP. * - Can access. * - access. Enum: 0, 1 - `result.data.dismissed_merge_candidates.merge_candidates.services.ftp.homedir` (string) The subaccount's FTP home directory. Example: "/subaccount" - `result.data.dismissed_merge_candidates.merge_candidates.services.ftp.quota` (integer) The maximum amount disk space, in megabytes (MB), that the subaccount may use. * A positive integer between and * - Unlimited. Example: 100 - `result.data.dismissed_merge_candidates.merge_candidates.services.webdisk` (object) This object contains information that indicates the subaccount's Web Disk status. - `result.data.dismissed_merge_candidates.merge_candidates.services.webdisk.enabled` (integer) Whether the subaccount can access Web Disk. * - Can access. * - access. Enum: 0, 1 - `result.data.dismissed_merge_candidates.merge_candidates.services.webdisk.homedir` (string) The subaccount's Web Disk home directory. Example: "/bob" - `result.data.dismissed_merge_candidates.merge_candidates.services.webdisk.perms` (string) Whether to grant write permissions to the subaccount. * - Read-only permissions. * - Read and write permissions. Enum: "ro", "rw" - `result.data.dismissed_merge_candidates.merge_candidates.services.webdisk.private` (integer) Whether to set the Web Disk directory's permissions to public or private. * - Private (). * - Public (). Enum: 0, 1 - `result.data.dismissed_merge_candidates.merge_candidates.special` (integer) Whether the account is a system-created special account that the user remove. * - A special account. * - a special account. Enum: 0, 1 - `result.data.dismissed_merge_candidates.merge_candidates.sub_account_exists` (integer) Whether a subaccount exists with the same username. * - Exists. * - Does exist. The function returns a value if the account is a service account. Enum: 0, 1 - `result.data.dismissed_merge_candidates.merge_candidates.synced_password` (integer) Whether the user has synchronized the passwords for each of the subaccount's service accounts. * - Synchronized. * - synchronized. The function returns a value if the account is a subaccount. Enum: 0, 1 - `result.data.dismissed_merge_candidates.merge_candidates.type` (string) The type of account. * - A subaccount. * - A hypothetical subaccount that does exist, but that the user could create as part of a merge. * - A service account. * - The cPanel account. Example: "sub" - `result.data.dismissed_merge_candidates.merge_candidates.username` (string) The username for the subaccount. * Length - 64 characters. * Characters - , , , dot (), hyphen (), underscore (). This value does include the domain name. Example: "example" - `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.status` (integer) * - Success. * - Failed. Check the field for more details. Enum: 0, 1 - `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.