Aliases

List domain aliases

[!NOTE] As of November 1st, 2024 the API endpoints for List domains and List domain aliases will default to 1000 max results per page. If you would like to opt-in to this behavior early, you can pass ?paginate=true as an additional querystring parameter to the URL for the endpoint query. See Pagination for more insight.

get/v1/domains/{domain_id}/aliases

Request

  • Base URL: https://api.forwardemail.net
  • URL: https://api.forwardemail.net/v1/domains/{domain_id}/aliases
  • Auth: HTTP basic

Query parameters

qstring

Search for aliases in a domain by name, label, or recipient (RegExp supported)

namestring

Search for aliases in a domain by name (RegExp supported)

recipientstring

Search for aliases in a domain by recipient (RegExp supported)

sortstring

Sort by a specific field (prefix with a single hyphen - to sort in reverse). Defaults to created_at.

pageinteger

Page of results to return. If not specified, value will be 1. Must be a number greater than or equal to 1.

limitinteger

Number of results to return per page. Defaults to 25 if not specified. Must be a number greater than or equal to 1, and less than or equal to 100.

Response

List of domain aliases

namestring required
labelsstring[] required
is_enabledboolean required
has_recipient_verificationboolean required
verified_recipientsstring[] required
pending_recipientsstring[] required
recipientsstring[] required
idstring required
object'alias' required
created_atstring date-time required
updated_atstring date-time required
storage_locationstring required
has_imapboolean required
retentioninteger required

Retention period in days (0-365) for Trash and Junk mailbox cleanup. 0 means automatic storage-based scaling.

smtp_limitinteger

Per-alias daily SMTP outbound message limit. Set to 0 to use the domain-level limit.

is_smtp_suspendedboolean

Whether this alias is currently suspended from outbound SMTP access.

smtp_suspended_sent_atstring date-time nullable

The date and time when the alias was suspended from outbound SMTP.

Example response

[
  {
    "user": {
      "email": "test@test.com",
      "display_name": "test@test.com",
      "id": "5efabd39xxxxxxx4512890b8"
    },
    "domain": {
      "name": "mailsire.com",
      "id": "5e3c0550xxxxxxx09b7ba023"
    },
    "name": "abc123",
    "labels": [],
    "is_enabled": true,
    "has_recipient_verification": false,
    "verified_recipients": [],
    "pending_recipients": [],
    "recipients": [
      "abc@test1.com"
    ],
    "id": "62fa3dcxxxxxxx79dda83ff2",
    "object": "alias",
    "created_at": "2022-08-15T12:36:26.593Z",
    "updated_at": "2022-08-15T12:36:26.593Z",
    "storage_location": "storage_loc",
    "has_imap": false,
    "retention": 0
  }
]

Changes

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