List saved and blocked plus aliases
curl --request GET \
--url https://console.mermail.app/api/v1/mailboxes/{mailboxId}/aliases \
--header 'x-api-key: <api-key>'import requests
url = "https://console.mermail.app/api/v1/mailboxes/{mailboxId}/aliases"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://console.mermail.app/api/v1/mailboxes/{mailboxId}/aliases', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://console.mermail.app/api/v1/mailboxes/{mailboxId}/aliases",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://console.mermail.app/api/v1/mailboxes/{mailboxId}/aliases"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://console.mermail.app/api/v1/mailboxes/{mailboxId}/aliases")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.mermail.app/api/v1/mailboxes/{mailboxId}/aliases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"enabled": true,
"address": "<string>",
"aliases": [
{
"id": "<string>",
"tag": "<string>",
"label": "<string>",
"saved": true,
"blockedAt": "2023-11-07T05:31:56Z",
"address": "[email protected]"
}
]
}Mailboxes
List saved and blocked plus aliases
Requires mailbox read access. Hosted mailboxes only. Valid unsaved aliases work automatically. Returns enabled=false when aliases are unavailable.
GET
https://console.mermail.app
/
api
/
v1
/
mailboxes
/
{mailboxId}
/
aliases
List saved and blocked plus aliases
curl --request GET \
--url https://console.mermail.app/api/v1/mailboxes/{mailboxId}/aliases \
--header 'x-api-key: <api-key>'import requests
url = "https://console.mermail.app/api/v1/mailboxes/{mailboxId}/aliases"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://console.mermail.app/api/v1/mailboxes/{mailboxId}/aliases', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://console.mermail.app/api/v1/mailboxes/{mailboxId}/aliases",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://console.mermail.app/api/v1/mailboxes/{mailboxId}/aliases"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://console.mermail.app/api/v1/mailboxes/{mailboxId}/aliases")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.mermail.app/api/v1/mailboxes/{mailboxId}/aliases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"enabled": true,
"address": "<string>",
"aliases": [
{
"id": "<string>",
"tag": "<string>",
"label": "<string>",
"saved": true,
"blockedAt": "2023-11-07T05:31:56Z",
"address": "[email protected]"
}
]
}Authorizations
API key (sk-proj-…) from Settings → API Keys. Required for sold API calls outside the Mermail console.
Path Parameters
Response
Alias availability and records
Hide child attributes
Hide child attributes
Plus tag, normalized to lowercase.
Required string length:
1 - 32Pattern:
^[a-zA-Z0-9](?:[a-zA-Z0-9._-]{0,30}[a-zA-Z0-9])?$Maximum string length:
80Was this page helpful?