logo
Alias APIList aliases owned by the API key

List aliases owned by the API key

curl -X GET "https://mail.haltman.io/api/alias/list?limit=42&offset=42" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "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/alias/list
GET
API Key (header: X-API-Key)
X-API-Keystring
Required

64-character lowercase hexadecimal API key.

64-character lowercase hexadecimal API key.
query
limitinteger

Page size. Default 50, maximum 200.

Min: 1 • Max: 200
query
offsetinteger

Zero-based page offset.

Min: 0
Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-API-Keystring
Required

API Key for authentication. 64-character lowercase hexadecimal API key.

Query Parameters

limitinteger

Page size. Default 50, maximum 200.

offsetinteger

Zero-based page offset.

Responses

itemsarray
Required
paginationobject
Required