List All email Notifier Patterns

List all email notifiers patterns

HTTP Request

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

Authorization

Authorization

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

Path Parameters

Parameter	Type	Required	Description
id	Integer	Yes	Unique ID of the email notifier

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`, `description`, `from_email`, `subject`, `body_text`, `body_html`
ordering	string	—	Order results by (`id`, `name`, `from_email`, `subject` , `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`).
has_description	boolean	—	filters patterns with/without description
has_from_email	boolean	—	filters patterns with/without from_email field
has_body_html	boolean	—	filters patterns with/without body_html
from_email	boolean	—	filters pattens by their from_email

Example Requests

🐍 Python

1import requests
2
3# List all email notifiers
4response = requests.get('http://www.example.com/api/notifications/notifiers/email/1/patterns',
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/1/patterns" -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 pattern.
name	String	Name of the email pattern (unique over the specific email notifier)
description	String	Extra descrtiption of the email pattern (nullable)
from_email	String	from email of the pattern (nullable)
subject	String	Subject of the email
body_text	String	Text body of the email pattern
body_html	String	Html body of the email pattern (nullable)
created_at	String (ISO 8601)	Timestamp when the email pattern was created.
updated_at	String (ISO 8601)	Timestamp when the email pattern was last updated.

Example Response

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
      {
          "id": 2,
          "name": "otp_code",
          "description": "used for sending otp codes",
          "from_email": "info@hamgam.online",
          "subject": "hamgam otp code",
          "body_text": "Your sign in otp code is {0}",
          "body_html": null,
          "created_at": "2025-12-28T18:13:33.402412Z",
          "updated_at": "2025-12-28T18:13:33.402419Z"
      },
      {
          "id": 3,
          "name": "order_status_changed",
          "description": "used for sending status changes",
          "from_email": "info@hamgam.online",
          "subject": "hamgam order status changed",
          "body_text": "Order number {0} is in {1} status",
          "body_html": null,
          "created_at": "2025-12-28T18:14:22.251792Z",
          "updated_at": "2025-12-28T18:14:22.251799Z"
      }
  ]
}