List Aliases

Retrieve all email aliases for a domain.

GET /domains/:domain_name/aliases

Example: /domains/example.com/aliases

Path Parameters

domain_name string required

The domain name for which to list aliases.

Example

curl -X GET https://api.mailcast.io/v1/domains/:domain_name/aliases \
     -H "Authorization: Bearer YOUR_API_TOKEN" \
     -H "Content-Type: application/json"

Response 200

{
  "aliases": [
    {
      "id": "alias_01k3tgwp77eqyvpvqrx3rbh98h",
      "match": "support",
      "state": "active",
      "actions": [
        {
          "type": "forward",
          "recipient": "company+support@gmail.com",
          "state": "active"
        }
      ],
      "created_at": "2025-08-29T12:00:00Z",
      "updated_at": "2025-08-29T12:00:00Z"
    },
    {
      "id": "alias_01k3tgwp78e468dpny5e1vab7q",
      "match": "*",
      "state": "active",
      "actions": [
        {
          "type": "passthrough",
          "mx_servers": [
            {
              "host": "smtp.google.com",
              "priority": 10
            }
          ],
          "state": "active"
        }
      ],
      "created_at": "2025-08-29T11:00:00Z",
      "updated_at": "2025-08-29T11:00:00Z"
    },
    {
      "id": "alias_01k3tgwp79fwhvae8jr3qtt72r",
      "match": "/\\w+/",
      "state": "active",
      "actions": [
        {
          "type": "webhook",
          "endpoint": "https://example.com/webhook",
          "method": "post",
          "format": "json",
          "fields": ["from", "to", "subject"],
          "headers": [],
          "extra_fields": [],
          "state": "active"
        }
      ],
      "created_at": "2025-08-29T10:00:00Z",
      "updated_at": "2025-08-29T10:00:00Z"
    }
  ]
}