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"
import requests
import json
url = "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"
headers = {
"Content-Type": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("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", {
method: "GET",
headers: {
"Content-Type": "application/json"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("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", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('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')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
response = http.request(request)
puts response.body
{
"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
}
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Forbidden",
"message": "You don't have permission to access this resource",
"code": 403
}
{
"error": "example_string",
"where": "example_string",
"reason": "example_string"
}
GET
/api/admin/aliases
GET
API Key (cookie: __Host-access)
__Host-accessstring
RequiredAccess-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
RequiredAPI 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
Requiredpaginationobject
RequiredWas this page helpful?
Last updated 2 days ago
Built with Documentation.AI