Skip to main content

Retrieve An Sms Notifier

Retrieve a specific sms notifier details

HTTP Request

GET/api/notifications/notifiers/sms notifiers/:id

Authorization

Authorization

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

Path Parameters

ParameterTypeRequiredDescription
idIntegerYesUnique ID of the sms notifier

Example Requests

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

Response Fields

FieldTypeDescription
idIntegerUnique ID of the sms notifier.
nameStringName of the sms notifier
backendStringName of the sms notifier backend
settingsJsonFieldJson key-value settings required for each notifier
created_atString (ISO 8601)Timestamp when the sms notifier was created.
updated_atString (ISO 8601)Timestamp when the sms notifier was last updated.

Response Example

{
"id": 6,
"name": "ippanel",
"backend": "ippanel",
"settings": {
"token": "value1",
"from_number": "+98915"
},
"created_at": "2025-12-28T15:56:29.610626Z",
"updated_at": "2025-12-28T15:56:29.610634Z"
}