Get an account¶

Retrieve information on a specific account

• HTTP Method: GET
• URL: https://example.domain.tld/api/v1/accounts/<username>/
• Require authentication: Yes
• Permission level required: MasterAdmin / DomainAdmin / MailUser

Path parameters¶

Parameter	Type	Description	Required
username	str	Account username to fetch	Required

Response parameters for MasterAdmin¶

Parameter	Type	Description
username	str	Account username
perm_level	str	Account permission level
api_access	int	Enabled (1) or disabled (0) API access
enabled	int	Enabled (1) or disabled (0) account
recovery_email	str	Email used for password reset
language	str	ISO 639-1 or ISO 639-2 language code
last_login	int	Previous login as UNIX timestamp (seconds)

Response parameters for DomainAdmin¶

Parameter	Type	Description
username	str	Account username
perm_level	str	Account permission level
api_access	int	Enabled (1) or disabled (0) API access
enabled	int	Enabled (1) or disabled (0) account
recovery_email	str	Email used for password reset
language	str	ISO 639-1 or ISO 639-2 language code
last_login	int	Previous login as UNIX timestamp (seconds)
domains	str	Comma separated list of administered domains
quota_aliases	int	Aliases quota
quota_aliases_used	int	Aliases quota used
quota_domainaliases	int	Domain aliases quota
quota_domainaliases_used	int	Domain aliases quota used
quota_domains	int	Domains quota
quota_domains_used	int	Domains quota used
quota_mailboxes	int	Mailboxes quota
quota_mailboxes_used	int	Mailboxes quota used
storagequota_total	int	Storage quota in MB
storagequota_used	int	Storage quota used in MB

Response parameters for MailUser¶

Parameter	Type	Description
username	str	Account username
perm_level	str	Account permission level
api_access	int	Enabled (1) or disabled (0) API access
enabled	int	Enabled (1) or disabled (0) account
recovery_email	str	Email used for password reset
language	str	ISO 639-1 or ISO 639-2 language code
last_login	int	Previous login as UNIX timestamp (seconds)
domain	str	Domain of email account
storagequota_total	int	Storage quota in MB
storagequota_used	int	Storage quota used in MB

Example request (Python)¶

import requests
import json
from pprint import pprint

url = "https://example.domain.tld/api/v1/accounts/u1@vonmail.com/"
r = requests.get(url, auth=("admin","long-auth_token-here"))
try:
    pprint(r.json())
except:
    print(r.text)

Example response (JSON)¶

{'api_access': 1,
 'domain': 'vonmail.com',
 'enabled': 1,
 'language': 'en',
 'last_login': 1582687584,
 'perm_level': 'MailUser',
 'recovery_email': 'recovery@domain.tld',
 'storagequota_total': 500,
 'storagequota_used': 0,
 'username': 'u1@vonmail.com'}