Domains

List domains

[!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

Request

  • Base URL: https://api.forwardemail.net
  • URL: https://api.forwardemail.net/v1/domains
  • Auth: HTTP basic

Query parameters

qstring

Search for domains by metadata.

domainstring

Search for domains by domain name.

sortstring

Sort by a specific field (prefix with a single hyphen - to sort in the reverse direction of that field). Defaults to created_at if not set.

pagestring

See Pagination for more insight.

limitstring

See Pagination for more insight.

Response

List of domains

domain_updatesobject[]
has_pending_domain_updatesboolean
has_newsletterboolean
ignore_mx_checkboolean
allow_subdomain_forwardingboolean

Allow wildcard subdomain forwarding. When enabled on a paid plan (Enhanced Protection or Team), any subdomain that has no DNS records of its own inherits the forwarding configuration published at this domain’s root (apex). Verified ownership is required: the apex must publish a forward-email-site-verification record matching this domain. This setting does not apply to the free plan.

has_delivery_logsboolean
retention_daysinteger
has_regexboolean
has_catchallboolean
allowliststring[]
denyliststring[]
restricted_alias_namesstring[]
has_adult_content_protectionboolean
has_phishing_protectionboolean
has_executable_protectionboolean
has_virus_protectionboolean
is_catchall_regex_disabledboolean
has_smtpboolean
is_smtp_suspendedboolean
planstring
max_recipients_per_aliasinteger
alias_default_smtp_limitinteger

Default daily SMTP sending limit applied to newly created aliases on this domain. Set to 0 to disable (aliases will use the domain-wide limit). Cannot exceed the domain's effective SMTP limit.

smtp_portstring
membersobject[]
invitesobject[]
namestring
has_mx_recordboolean
has_txt_recordboolean
has_dkim_recordboolean
has_return_path_recordboolean
has_dmarc_recordboolean
has_strict_dmarcboolean
has_spf_recordboolean
has_autoconfig_recordboolean
has_autodiscover_recordboolean
has_recipient_verificationboolean
has_custom_verificationboolean
has_custom_s3boolean

Whether this domain uses custom S3-compatible storage for backups

s3_endpointstring

Custom S3-compatible endpoint URL (e.g. https://s3.us-east-1.amazonaws.com, https://<accountid>.r2.cloudflarestorage.com)

s3_regionstring

S3 region (e.g. us-east-1, auto). Defaults to auto if not specified.

s3_bucketstring

S3 bucket name for storing backups. The bucket must already exist.

require_tls_inboundboolean

When enabled, reject inbound emails not sent over TLS

verification_recordstring
idstring
object'domain'
created_atstring date-time
updated_atstring date-time
storage_usedinteger
storage_used_by_aliasesinteger
storage_quotainteger
zone_filestring

Every DNS record the domain needs (MX, verification, SPF, DKIM, Return-Path, DMARC, and autodiscovery) as a zone file to import into a DNS provider. Only included when a domain is retrieved or created, for domain admins.

linkstring uri

Changes

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