Email domains / List
Returns all email domains.
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/email_domains
Method: GET
Authorisation: Minimum role: USER
Response object
Response status: 200 (OK)
Response type: DTO_email_domain[]
Wrapper: DTO_response_wrap_get_many
Other response statuses: 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_standard_filter
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| sort_by_key | String | Sort by key | |
| response_field_keys | String[] | Only return the fields specified | |
| filters | String[] | Each string needs to be structured: filters=field_key:operator:value1|value2|value3 Only used to store filters for passing along as querystring | |
| include_aggregations | Boolean | Include aggregations | |
| include_imported | Boolean | Include imported | |
| search | String | Search | |
| sort_order | ENUM sort_order | Sort order | |
| take | Int32 | Take | |
| page | Int32 | Page |
DTO_email_domain
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| created_by | DTO_reference_user | ReadOnly | Created by |
| last_updated_by | DTO_reference_user | ReadOnly | Last updated by |
| id | Int32 | ReadOnly | Leave empty on input |
| domain_name | String | Domain name | |
| status | ENUM email_domain_status | ReadOnly | Status |
| type | ENUM email_domain_type | ReadOnly | Type |
| created | DateTime | ReadOnly | Created |
| last_updated | DateTime | ReadOnly | Last updated |
| verified | DateTime (nullable) | ReadOnly | Verified |
DTO_reference_user
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| profile_pic | String | ReadOnly | Profile pic |
| String | ReadOnly | ||
| id | Int32 | Id | |
| label | Object | ReadOnly | Label |
ENUM sort_order
| Value | Name | Description |
|---|---|---|
| 0 | ASC | ASC |
| 1 | DESC | DESC |
ENUM email_domain_status
| Value | Name | Description |
|---|---|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | PENDING | PENDING |
| 2 | VERIFIED | VERIFIED |
ENUM email_domain_type
| Value | Name | Description |
|---|---|---|
| 0 | CUSTOM | CUSTOM |
| 1 | TENANT_DEFAULT | TENANT_DEFAULT |
