List All SMS Notifiers

List all sms notifiers.

HTTP Request

GET/api/notifications/notifiers/sms

Authorization

Authorization

• Required: Yes
• Permission: Staff with SMSNotifierPermission or Admin
• Permission Code: 2812
• 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`
ordering	string	—	Order results by (`id`, `name`, `backend`, `created_at`, `updated_at`
id_min	integer	—	Minimum ID of the sms notifier.
id_max	integer	—	Maximum ID of the sms 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 sms notifiers created after this date (`YYYY-MM-DD`).
updated_from	string	—	Start date for sms notifieres updated after this date (`YYYY-MM-DD`).
created_to	string	—	End date for sms notifiers created before this date (`YYYY-MM-DD`).
updated_to	string	—	End date for sms notifiers updated before this date (`YYYY-MM-DD`).
backend	String	—	Filter by backend type of the sms notifier (choices: `melipayamak`, `ippanel`)
has_settings	Boolean	—	Filter sms notifiers with/without defined settings

Example Requests

🐍 Python

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

🌐 Curl

1# List all sms notifiers
2curl "http://www.example.com/api/notifications/notifiers/sms" -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 SMSNotifier objects

SMSNotifier Object Data Structure

Field	Type	Description
id	Integer	Unique ID of the sms notifier.
name	String	Name of the sms notifier
backend	String	Name of the sms notifier backend
settings	JsonField	Json key-value settings required for each notifier
created_at	String (ISO 8601)	Timestamp when the sms notifier was created.
updated_at	String (ISO 8601)	Timestamp when the sms notifier was last updated.

Example Response

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
      {
          "id": 2,
          "name": "ippanel_one",
          "backend": "ippanel",
          "settings": {
              "key": "someippanelkey"
          },
          "created_at": "2025-11-22T13:35:15.990097Z",
          "updated_at": "2025-11-22T13:35:15.990101Z"
      },
      {
          "id": 1,
          "name": "melipayamak",
          "backend": "melipayamak",
          "settings": {
              "key": "value"
          },
          "created_at": "2025-11-22T13:34:54.742799Z",
          "updated_at": "2025-11-28T15:18:44.765581Z"
      }
  ]
}