Get user accounts

GET /api/2.0/mail/accounts

Request

Returns a list of all the user mailboxes, aliases, and groups.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

usernamestring

User name

Examples

GET /api/2.0/mail/accounts HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request GET \
  --url https://example.com/api/2.0/mail/accounts \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

List of user mailboxes, aliases and groups

MailboxIdintegerformat: int32

Emailstring

Enabledboolean

Namestring

OAuthConnectionboolean

Signatureobject

MailboxIdintegerformat: int32

Htmlstring

IsActiveboolean

Autoreplyobject

MailboxIdintegerformat: int32

TurnOnboolean

OnlyContactsboolean

TurnOnToDateboolean

FromDatestringformat: date-time

ToDatestringformat: date-time

Subjectstring

Htmlstring

EMailInFolderstring

QuotaErrorboolean

AuthErrorboolean

IsGroupboolean

IsAliasboolean

IsTeamlabMailboxboolean

IsDefaultboolean

IsSharedDomainMailboxboolean

DateCreatedarray of string

401

Unauthorized