---
title: "GET /api/v2/aliases/"
method: GET
path: "/api/v2/aliases/"
tags: ["aliases"]
---

# GET /api/v2/aliases/

`GET /api/v2/aliases/`

Viewset for Alias.

## Query parameters

- `domain` integer
- `ordering` string
- `page` integer
- `page_size` integer
- `search` string

## Response `200`

- PaginatedAliasList
  - `count` integer, required
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` Alias[], required
    - `pk` integer, required
    - `address` string, email, required
    - `enabled` boolean — Check to activate this alias
    - `recipients` string[], required — A list of recipient
    - `expire_at` string, date-time, nullable
    - `description` string
    - `creation` string, date-time
    - `last_modification` string, date-time, required

---

[API](https://skmtc.dev/modoboa/apis/modoboa-api.md) · [All operations](https://skmtc.dev/modoboa/apis/modoboa-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/modoboa/modoboa-api/revisions/01f8eaf44cc7/schema)
