v1
latestOpenAPI 3.1.12026-07-17111158225.7 KBdomain emailforwards
List email forwards
Lists email forwards for the domain.
get/{account}/domains/{domain}/email_forwards
Path parameters
accountinteger required
The account id
domainstring required
The domain name or id
Query parameters
sort'id:asc' | 'id:desc' | 'alias_email:asc' | 'alias_email:desc' | 'destination_email:asc' | 'destination_email:desc'
Sort results. Default sorting is by id.
Response
Successfully retrieved email forward list.
Example response
{
"data": [
{
"id": 1,
"domain_id": 2,
"alias_email": "john.doe@a-domain.com",
"destination_email": "john@example.com",
"created_at": "2016-02-04T14:26:50Z",
"updated_at": "2016-02-04T14:26:50Z",
"active": true
}
],
"pagination": {
"current_page": 1,
"per_page": 30,
"total_entries": 2,
"total_pages": 1
}
}