Skip to main content

GET List subdomains

GET /v3/relay/subdomains

Return a list of PrivateEmailSubdomain objects

Request Headers​

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

Query Params​

Return​

This API returns a list of Private Email Subdomain objects. If no more subdomain objects are available, the resulting array will be empty. This request should never raise an error.

Example​

Request​

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

Response​

[
    {
        "id": 1,
        "subdomain": "mysubdomain"
    }
]