Sign in

v1

latestOpenAPI 3.1.02026-07-2671111437.2 KB
Email Forwardings

List Email Forwardings

Returns a paginated list of all email forwarding rules for a domain.

get/core/v1/domains/{domainName}/email/forwarding

Path parameters

domainNamestring required

DomainName is the domain to list email forwarded boxes for.

Query parameters

perPageinteger

Maximum number of records to return per page for paginated list endpoints.

Example:100

(optional) Per Page is the number of records to return per request. Per Page defaults to 500 if not set.

pageinteger
Example:1

(optional) Page is which page to return. Default to page 1 if not set.

Response

A successful response.

lastPageinteger

LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.

nextPageinteger

NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.

Example response

{
  "emailForwarding": [
    {
      "domainName": "example.com",
      "emailBox": "admin",
      "emailTo": "webmaster@example.com"
    }
  ]
}