Sign in
Client - Email Accounts

List email accounts for a domain owned by the caller

Filters by domain_id. The domain must belong to the caller's account (enforced server-side).

get/api/client/email-accounts

Query parameters

domain_idinteger required

ID of the domain to filter by (must belong to the caller's account)

Response

List of email accounts

idinteger

ID of the email account

hosting_account_idinteger

ID of the related hosting account

domain_idinteger

ID of the related domain

usernamestring

Email username (local part)

namestring

Display name for the email account

receive_incoming_emailboolean

Whether the account can receive incoming email

sending_outgoing_emailboolean

Whether the account can send outgoing email

logging_inboolean

Whether login is enabled for this account

storage_space_settingsstring

Storage space settings (raw value)

quotastring

Quota for the email account (in MB or bytes)

automatically_create_foldersboolean

Whether to automatically create folders for the account

send_welcome_emailboolean

Whether to send a welcome email on creation

statusstring

Status of the email account (active, suspended, etc.)

full_emailstring

Full email address (username@domain)

Changes

No recorded changes to this endpoint across all 1 revision of this API.