Skip to main content

Retrieve An email Notifier

Retrieve a specific email notifier details

HTTP Request

GET/api/notifications/notifiers/email notifiers/:id

Authorization

Authorization

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

Path Parameters

ParameterTypeRequiredDescription
idIntegerYesUnique ID of the email notifier

Example Requests

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

Response Fields

FieldTypeDescription
idIntegerUnique ID of the email notifier.
nameStringName of the email notifier
hostStringHost name of the email notifier
portIntegerPort number of the email notifier
usernameStringUsername of the email notifier
passwordStringPassword of the email notifier
from_emailStringSender email address of the email notifier
use_tlsBooleanWhether the email notifier use tls or not
use_sslBooleanWhether the email notifier use ssl or not
fail_silentlyBooleanWhether the email notifier will fail silently in case of error
created_atString (ISO 8601)Timestamp when the email notifier was created.
updated_atString (ISO 8601)Timestamp when the email notifier was last updated.

Response Example

{
"id": 8,
"name": "hamgam_mail",
"host": "mail.hamgam.online",
"port": 887,
"username": "info",
"password": "somepassword",
"from_email": "info@hamgam.online",
"use_tls": true,
"use_ssl": true,
"fail_silently": false,
"created_at": "2025-12-28T17:43:38.130046Z",
"updated_at": "2025-12-28T17:43:38.130054Z"
}