Endpoints

Get all aliases.

This endpoint lets you get all your aliases.

get/api/v1/aliases

Request

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

Query parameters

pageobject nullable

Pagination options.

page.numberinteger nullable

The page to return. Must be at least 1.

Example:1
page.sizeinteger nullable

Aliases per page, up to 100. Must not be greater than 100. Must be at least 1.

Example:100
filterobject nullable

Filters to apply.

searchstring nullable

Search aliases by email or note, 3 to 50 characters. Must not be greater than 50 characters. Must be at least 3 characters.

Example:shop
filter.is_activeinteger nullable

Return only active (1) or inactive (0) aliases. Must not be greater than 1. Must be at least 0.

Example:1
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.

Example:-created_at

Response

Example response

{
  "data": [
    {
      "email": "gbailey@relay.hidemail.app",
      "is_active": true,
      "note": null,
      "total_forwarded": 0,
      "total_blocked": 0,
      "created_at": "2026-10-08 20:26:19",
      "updated_at": "2026-10-08 20:26:19"
    },
    {
      "email": "cecil42@relay.hidemail.app",
      "is_active": true,
      "note": null,
      "total_forwarded": 0,
      "total_blocked": 0,
      "created_at": "2026-10-08 20:26:19",
      "updated_at": "2026-10-08 20:26:19"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.