Get all sender addresses
Fetch all sender addresses
- HTTP Method:
GET
- URL:
https://example.domain.tld/api/v1/sender_addresses/
- 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 |
sender_addresses |
list |
List of all sender addresses |
sender_address |
str |
Sender address |
usernames |
str |
Comma separated list of MailUsers authorized to send emails from the sender address |
Example request (Python)
import requests
import json
from pprint import pprint
url = "https://example.domain.tld/api/v1/sender_addresses/?limit=50&start=0"
r = requests.get(url, auth=("admin","long-auth_token-here"))
try:
pprint(r.json())
except:
print(r.text)
Example response (JSON)
{'sender_addresses': [{'sender_address': 'sa1@vonmail.com',
'usernames': 'u1@vonmail.com,u2@vonmail.com'}]}