---
title: "List domain aliases"
method: GET
path: "/v1/domains/{domain_id}/aliases"
tags: ["Aliases"]
---

# List domain aliases

`GET /v1/domains/{domain_id}/aliases`

## Request

- Base URL: `https://api.forwardemail.net`
- URL: `https://api.forwardemail.net/v1/domains/{domain_id}/aliases`
- Auth: HTTP basic

>[!NOTE]
>As of November 1st, 2024 the API endpoints for `List domains` and `List domain aliases` will default to `1000` max results per page. If you would like to opt-in to this behavior early, you can pass `?paginate=true` as an additional querystring parameter to the URL for the endpoint query. See Pagination for more insight.

## Query parameters

- `q` string
- `name` string
- `recipient` string
- `sort` string
- `page` integer
- `limit` integer

## Response `200`

List of domain aliases

- Alias[]
  - `user` object, required
    - `email` string, email, required
    - `display_name` string, required
    - `id` string, required
  - `domain` object, required
    - `name` string, required
    - `id` string, required
  - `name` string, required
  - `labels` string[], required
  - `is_enabled` boolean, required
  - `has_recipient_verification` boolean, required
  - `verified_recipients` string[], required
  - `pending_recipients` string[], required
  - `recipients` string[], required
  - `id` string, required
  - `object` 'alias', required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `storage_location` string, required
  - `has_imap` boolean, required
  - `retention` integer, required: Retention period in days (0-365) for Trash and Junk mailbox cleanup. 0 means automatic storage-based scaling.
  - `smtp_limit` integer: Per-alias daily SMTP outbound message limit. Set to 0 to use the domain-level limit.
  - `is_smtp_suspended` boolean: Whether this alias is currently suspended from outbound SMTP access.
  - `smtp_suspended_sent_at` string, date-time, nullable: The date and time when the alias was suspended from outbound SMTP.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

---

[API](https://skmtc.dev/forwardemail/apis/forward-email-api.md) · [All operations](https://skmtc.dev/forwardemail/apis/forward-email-api/llms.txt) · [OpenAPI document](https://skmtc.dev/forwardemail/apis/forward-email-api/revisions/ecefab4527f6?raw)