---
title: "List aliases"
method: GET
path: "/aliases"
tags: ["Aliases"]
---

# List aliases

`GET /aliases`

## Request

- Base URL: `https://faivelo.com/api/v1`
- URL: `https://faivelo.com/api/v1/aliases`
- Auth: HTTP bearer

Returns all aliases, optionally filtered by domain. Requires scope `aliases:read`.

## Query parameters

- `domain` string

## Response `200`

Alias list

- object
  - `success` boolean
  - `data` Alias[]
    - `address` string
    - `localPart` string
    - `destinations` string[]
    - `active` boolean
    - `createdAt` string, date-time

## Other responses

- `401`: Missing or invalid API key
- `402`: The account's plan does not include the API (`plan_required`)
- `403`: The key lacks the required scope
- `429`: Rate limit exceeded

---

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