DNdnsimple
domain emailforwards

List email forwards

Changed on

Lists email forwards for the domain.

get/{account}/domains/{domain}/email_forwards

Request

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
  }
}

Changes

  • v2ad25852bccdeRevision changes
    • breaking

      removed the enum value from:asc from the query request parameter sort

    • breaking

      removed the enum value from:desc from the query request parameter sort

    • breaking

      removed the enum value to:asc from the query request parameter sort

    • breaking

      removed the enum value to:desc from the query request parameter sort

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the new enum value alias_email:asc to the query request parameter sort

    • info

      added the new enum value alias_email:desc to the query request parameter sort

    • info

      added the new enum value destination_email:asc to the query request parameter sort

    • info

      added the new enum value destination_email:desc to the query request parameter sort

  • v206780be0ef17Revision changes
    • info

      the response property became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status