---
title: "Get all aliases."
method: GET
path: "/api/v1/aliases"
tags: ["Endpoints"]
---

# Get all aliases.

`GET /api/v1/aliases`

## Request

- Base URL: `https://hidemail.app`
- URL: `https://hidemail.app/api/v1/aliases`
- Auth: HTTP bearer

This endpoint lets you get all your aliases.

## Query parameters

- `page` object, nullable: Pagination options.
- `page.number` integer, nullable: The page to return. Must be at least 1.
- `page.size` integer, nullable: Aliases per page, up to 100. Must not be greater than 100. Must be at least 1.
- `filter` object, nullable: Filters to apply.
- `search` string, nullable: Search aliases by email or note, 3 to 50 characters. Must not be greater than 50 characters. Must be at least 3 characters.
- `filter.is_active` integer, nullable: Return only active (1) or inactive (0) aliases. Must not be greater than 1. Must be at least 0.
- `sort` 'email' | 'is_active' | 'created_at' | 'updated_at' | 'total_blocked' | 'total_forwarded' | '-total_blocked' | '-total_forwarded' | '-email' | '-is_active' | '-created_at' | '-updated_at', nullable: Sort field. Prefix with - for descending order. Must not be greater than 50 characters. Must be at least 3 characters.

## Response `200`

- object
  - `data` object[]
    - `email` string
    - `is_active` boolean
    - `note` string, nullable
    - `total_forwarded` integer
    - `total_blocked` integer
    - `created_at` string
    - `updated_at` string

---

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