List All Email Notifiers

List all email notifiers.

HTTP Request

GET/api/notifications/notifiers/email

Authorization

Authorization

• Required: Yes
• Permission: Staff with EmailNotifierPermission or Admin
• Permission Code: 2832
• Authentication: Token-based (Authorization: Token <your_api_key>)

Query Parameters

Parameter	Type	Default	Description
limit	integer	—	Number of results to return per page.
offset	integer	—	Number of results to skip before returning results.
search	string	—	Search term to lookup results by`id`, `name`, `host`, `username`, `from_email`
ordering	string	—	Order results by (`id`, `name`, `host`, `port`, `username`, `from_email`, `created_at`, `updated_at`
id_min	integer	—	Minimum ID of the email notifier.
id_max	integer	—	Maximum ID of the email notifier.
created_date	string	—	Exact creation date (`YYYY-MM-DD`).
updated_date	string	—	Exact last update date (`YYYY-MM-DD`).
created_from	string	—	Start date for email notifiers created after this date (`YYYY-MM-DD`).
updated_from	string	—	Start date for email notifieres updated after this date (`YYYY-MM-DD`).
created_to	string	—	End date for email notifiers created before this date (`YYYY-MM-DD`).
updated_to	string	—	End date for email notifiers updated before this date (`YYYY-MM-DD`).
host	string	—	Filter by host of the email notifiers
port	integer	—	Filter by port of the email notifier
from_email	string	—	Filter by sender mail address
use_tls	boolean	—	Filter email notifiers using/not using tls
use_ssl	boolean	—	Filter email notifiers using/not using ssl
fail_silently	boolean	—	Filter email notifiers that will/will not fail silently

Example Requests

🐍 Python

1import requests
2
3# List all email notifiers
4response = requests.get('http://www.example.com/api/notifications/notifiers/email',
5  headers={'Authorization': 'Token <your_api_key>'}
6)
7print(response.json())

🌐 Curl

1# List all email notifiers
2curl "http://www.example.com/api/notifications/notifiers/email" -H "Authorization: Token <your_api_key>"

Object Structure

Field	Type	Description
count	Integer	Total number of categories
next	String	URL for the next page of results
previous	String	URL for the previous page of results
results	Array[Object]	Array of EmailNotifier objects

EmailNotifier Object Data Structure

Field	Type	Description
id	Integer	Unique ID of the email notifier.
name	String	Name of the email notifier
host	String	Host name of the email notifier
port	Integer	Port number of the email notifier
username	String	Username of the email notifier
password	String	Password of the email notifier
from_email	String	Sender email address of the email notifier
use_tls	Boolean	Whether the email notifier use tls or not
use_ssl	Boolean	Whether the email notifier use ssl or not
fail_silently	Boolean	Whether the email notifier will fail silently in case of error
created_at	String (ISO 8601)	Timestamp when the email notifier was created.
updated_at	String (ISO 8601)	Timestamp when the email notifier was last updated.

Example Response

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
      {
          "id": 3,
          "name": "moeinmail",
          "host": "mail.moeinmail.ir",
          "port": 587,
          "username": "admin",
          "password": "123",
          "from_email": "admin@moeinmail.ir",
          "use_tls": true,
          "use_ssl": false,
          "fail_silently": false,
          "created_at": "2025-11-22T13:35:43.794813Z",
          "updated_at": "2025-11-22T13:35:43.794818Z"
      }
  ]
}