Skip to main content

GET List addresses

GET /v3/relay/addresses

Return a list of PrivateEmailAddress objects

Request Headers

Accept: application/json
Authorization: Bearer {{api_key}}

Query Params

ParamDescriptionExample value
pageThe page param. Default is 11
pagingPaging or not. if value is 1, the result will be paginated. Default is 01
sizePage size param. Default is 10100


A dictionary with a results property that contains Private Email objects if the paging parameter value is 1. Else, this API returns a list of Private Email objects. If no more Private Email objects are available, the resulting array will be empty. This request should never raise an error.



curl --location -g --request GET '{{host}}/v3/relay/addresses' \
--header 'Authorization: Bearer {{api_key}}'


"count": 1,
"next": null,
"previous": null,
"results": [
"id": 1,
"address": "mycustomalias",
"enabled": false,
"block_spam": true,
"description": "",
"created_time": 1657159423,
"updated_time": 1663832574,
"num_forwarded": 1,
"num_blocked": 0,
"num_replied": 0,
"num_spam": 0,
"domain": "",
"subdomain": null,
"full_address": "[email protected]"