Skip to main content

Retrieve A email Notifier Pattern

Retrieve a specific email notifier pattern details

HTTP Request

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

Authorization

Authorization

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

Path Parameters

ParameterTypeRequiredDescription
notifier_idIntegerYesUnique ID of the email notifier
idIntegerYesUnique ID of the email pattern

Example Requests

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

Response Fields

FieldTypeDescription
idIntegerUnique ID of the email pattern.
nameStringName of the email pattern (unique over the specific email notifier)
descriptionStringExtra descrtiption of the email pattern (nullable)
from_emailStringfrom email of the pattern (nullable)
subjectStringSubject of the email
body_textStringText body of the email pattern
body_htmlStringHtml body of the email pattern (nullable)
created_atString (ISO 8601)Timestamp when the email pattern was created.
updated_atString (ISO 8601)Timestamp when the email pattern was last updated.

Response Example

{
"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"
}