# Return domain-level forwarders

This function lists domain-level forwarders.

Important:

  When you disable the Receive Mail role, the system disables this function.

Endpoint: GET /Email/list_domain_forwarders
Version: 11.137.9999.96
Security: BasicAuth

## Query parameters:

  - `domain` (string)
    The domain name to query. If you do not use this parameter, the function returns all domain-level forwarders on the cPanel account.
    Example: "example.com"

## Response 200 fields (application/json):

  - `apiversion` (integer)
    The version of the API.
    Example: 3

  - `func` (string)
    The name of the method called.
    Example: "list_domain_forwarders"

  - `module` (string)
    The name of the module called.
    Example: "Email"

  - `result` (object)

  - `result.data` (array)
    An array of objects containing domain forwarder information.

  - `result.data.dest` (string)
    The forwarded domain.
    Example: "example.com"

  - `result.data.forward` (string)
    The destination domain.
    Example: "forwardtome.com"

  - `result.errors` (array,null)
    List of errors if the API failed.

  - `result.messages` (array,null)
    List of messages generated by the API.

  - `result.metadata` (object)

  - `result.metadata.transformed` (integer)
    Post-processing may have transformed the data.
    Enum: 1

  - `result.status` (integer)
    * 1 - Success.
* 0 - Failed. Check the errors field for more details.
    Enum: 0, 1

  - `result.warnings` (array,null)
    List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.