Skip to main content
GET
/
core
/
v1
/
domains
/
{domainName}
/
email
/
forwarding
List Email Forwardings
curl --request GET \
  --url https://api.dev.name.com/core/v1/domains/{domainName}/email/forwarding \
  --header 'Authorization: Basic <encoded-value>'
{
  "emailForwarding": [
    {
      "domainName": "example.com",
      "emailBox": "admin",
      "emailTo": "[email protected]"
    }
  ],
  "lastPage": 123,
  "nextPage": 123
}

Authorizations

​
Authorization
string
header
required

Authenticate via HTTP Basic with your account username and API token. Examples use an explicit 'Authorization: Basic <base64(username:token)>' header; 'curl -u username:token' is equivalent. For sandbox, append "-test" to your username and use your sandbox token on api.dev.name.com.

Path Parameters

​
domainName
string
required

DomainName is the domain to list email forwarded boxes for.

Query Parameters

​
perPage
integer<int32>

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

Example:

100

​
page
integer<int32>

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

Example:

1

Response

A successful response.

ListEmailForwardingsResponse returns the list of email forwarding entries as well as the pagination information.

​
emailForwarding
object[]
required

EmailForwarding is the list of forwarded email boxes.

​
lastPage
integer<int32>

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.

​
nextPage
integer<int32>

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.