anon_email
API referenceAccount

Get the account profile

GET
/account

The caller's profile: display name, default alias format and default recipient, plus live alias and recipient counts and creation time.

An account whose provisioning trigger has not fired yet reads as defaults with zero counts rather than 404.

Authorization

CognitoUserPool
headerAuthorizationBearer <token>

Cognito user pool ID token. API Gateway validates the token (identity token: no OAuth scopes are configured on the authorizer) and forwards its claims; the sub claim is the tenant key.

Response Body

The account profile.

application/json
  1. response
user_sub*string

The caller's Cognito subject id.

from_name*string

Display name used on forwarded mail. Empty when never set.

default_alias_format*AliasFormat

How a generated alias local part is produced: random English words joined with separators, or a UUID.

Value in"random_words""uuid"
default_recipient_id*string

Recipient new aliases forward to by default. Empty when unset.

alias_count*integer

Aliases currently held, against the plan's limit.

recipient_count*integer

Recipients currently held, against the plan's limit.

datetime_created*integer

Account creation time, unix epoch milliseconds.

curl -X GET "https://example.com/account"
{  "user_sub": "string",  "from_name": "string",  "default_alias_format": "random_words",  "default_recipient_id": "string",  "alias_count": 0,  "recipient_count": 0,  "datetime_created": 0}