Get an email subscription, or search them
eurodns_email_get_subscriptionFetch a single email subscription's mailbox, aliases, and catch-all state by ID, or search subscriptions by status, domain, or username. Use the returned ID for alias, catch-all, or password updates.
Instructions
Returns one email subscription — the mailbox, its aliases and catch-all state — by id, or searches the account’s email subscriptions by status, domain and user name when id is omitted. Its id is what eurodns_email_set_alias, eurodns_email_set_catchall and eurodns_email_update_password take; every product at once is eurodns_subscription_search.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Numeric id of the email subscription to return. Omit it to search the account’s email subscriptions with the filters below. | |
| page | No | 1-based page number. There is no page meaning everything: walk pages until a short one comes back. | |
| size | No | Results per page, 1 to 500. A wide page is truncated by the character limit, so prefer a filter to a large size. | |
| userName | No | Filter on the mailbox user name, the part before the @. | |
| sortField | No | Result field to sort on, spelled as in the response items. Unsorted when omitted. | |
| sortOrder | No | ASC or DESC; only read with sortField. | |
| domainName | No | The domain name the email subscription(s) you search for are related to | |
| subscriptionStatus | No | Keep only subscriptions in this lifecycle status, e.g. ACTIVE, TO_RENEW or PROVISIONING. Omit for every status. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | Response body as returned by the API. | |
| status | Yes | Upstream HTTP status code. |