API referenceAliases
List aliases
GET
All aliases owned by the caller, sorted by address.
The optional q prefix search and active filter are applied by the
API. The response is always a bare JSON array, empty when nothing
matches.
CognitoUserPoolheader
AuthorizationBearer <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.
q?stringCase-insensitive prefix match on the alias address (alias_email).
active?booleanFilter by whether the alias accepts mail. Omit to return both.
The caller's aliases.
application/json- response
[index: integer]?curl -X GET "https://example.com/aliases?q=news&active=true"[ { "alias_id": "string", "alias_email": "user@example.com", "description": "string", "active": true, "destination_emails": [ "user@example.com" ], "emails_sent": 0, "emails_delivered": 0, "emails_bounced": 0, "emails_complaint": 0, "emails_replied": 0, "emails_blocked": 0, "datetime_last_sent": 0, "datetime_last_delivered": 0, "datetime_last_bounced": 0, "datetime_last_complaint": 0, "datetime_last_blocked": 0, "datetime_last_replied": 0, "datetime_created": 0, "datetime_updated": 0, "datetime_deleted": 0 }]