Get all aliases

Fetch all aliases

  • HTTP Method: GET
  • URL: https://example.domain.tld/api/v1/aliases/
  • Require authentication: Yes
  • Permission level required: MasterAdmin / DomainAdmin

Query parameters

Parameter Type Description Required
limit int Number of records (max 50) Optional
start int Record offset Optional
search str Search term Optional

Response parameters

Parameter Type Description
aliases list List of all aliases
alias str Alias address
recipients str Comma separated list of recipient addresses

Example request (Python)

import requests
import json
from pprint import pprint

url = "https://example.domain.tld/api/v1/aliases/?limit=50&start=0"
r = requests.get(url, auth=("admin","long-auth_token-here"))

Example response (JSON)

{'aliases': [{'alias': '',
              'recipients': ''},
             {'alias': '',
              'recipients': ','}]}