logo
AdminList aliases

List aliases

curl -X GET "https://mail.haltman.io/api/admin/aliases?limit=42&offset=42&active=true&goto=example_string&domain=example_string&handle=example_string&address=123 Main St" \
  -H "Content-Type: application/json"
{
  "items": [
    {
      "id": 123,
      "address": "123 Main St",
      "goto": "example_string",
      "active": 42,
      "domain_id": 123,
      "created": "2024-12-25T10:00:00Z",
      "modified": "2024-12-25T10:00:00Z"
    }
  ],
  "pagination": {
    "total": 42,
    "limit": 42,
    "offset": 42
  }
}
GET
/api/admin/aliases
GET
API Key (cookie: __Host-access)
__Host-accessstring
Required

Access-session cookie used for user and admin authentication.

Access-session cookie used for user and admin authentication.
query
limitinteger

Page size. Default 50, maximum 200.

Min: 1 • Max: 200
query
offsetinteger

Zero-based page offset.

Min: 0
query
activestring

Boolean-like filter accepting 0/1 and common textual equivalents.

Request Preview
Response

Response will appear here after sending the request

Authentication

path
parameterstring
Required

API Key for authentication. Access-session cookie used for user and admin authentication.

Query Parameters

limitinteger

Page size. Default 50, maximum 200.

offsetinteger

Zero-based page offset.

activestring

Boolean-like filter accepting 0/1 and common textual equivalents.

Responses

itemsarray
Required
paginationobject
Required