Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Muhammadbugaje/NAMETS_Website/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint returns all subscribers whose is_active flag is True. You can narrow the results using query parameters that match each subscriber’s notification preferences. Both available endpoint paths accept identical parameters and return the same shape of data — they differ only in the serializer fields included (see the table below).

​
Endpoint paths

PathSource moduleSerializer fields
GET /api/subscribers/api/views.pyid, email, notify_announcements, notify_events, notify_prayer_changes
GET /api/communications/subscribers/communications/views_api.pyid, email, phone, notify_announcements, notify_events, notify_prayer_changes, is_active
Both paths require the X-N8N-Token header.

​
Query parameters

​
announcements
string
When present (any non-empty value), restricts results to subscribers where notify_announcements = True. Use this to build the recipient list for an announcement notification.Example: ?announcements=1
​
events
string
When present, restricts results to subscribers where notify_events = True. Use this to target subscribers who opted in to event reminders.Example: ?events=1
​
prayer
string
When present, restricts results to subscribers where notify_prayer_changes = True. Use this for prayer-time update notifications.Example: ?prayer=1
Filters can be combined. A subscriber must satisfy all supplied filters to be included.

​
Response fields

​
id
integer
The unique primary key of the subscriber record.
​
email
string
The subscriber’s email address. Always unique across all records.
​
phone
string
The subscriber’s phone number. Returned only by the /api/communications/subscribers/ path.
​
notify_announcements
boolean
true if the subscriber has opted in to announcement email notifications.
​
notify_events
boolean
true if the subscriber has opted in to event reminder emails.
​
notify_prayer_changes
boolean
true if the subscriber has opted in to prayer-time change notifications.
​
is_active
boolean
Whether the subscription is active. Returned only by the /api/communications/subscribers/ path. All records returned by either endpoint are guaranteed to have is_active = true at query time.

​
Examples

List all active subscribers: 
curl -H "X-N8N-Token: your_api_token" \
  https://your-site.onrender.com/api/subscribers/
List subscribers who want announcement emails: 
curl -H "X-N8N-Token: your_api_token" \
  "https://your-site.onrender.com/api/subscribers/?announcements=1"
List subscribers who want both event and prayer-time emails: 
curl -H "X-N8N-Token: your_api_token" \
  "https://your-site.onrender.com/api/subscribers/?events=1&prayer=1"
Via the communications path: 
curl -H "X-N8N-Token: your_api_token" \
  "https://your-site.onrender.com/api/communications/subscribers/?announcements=1"

​
Example response

The /api/subscribers/ path returns: 
[
  {
    "id": 1,
    "email": "[email protected]",
    "notify_announcements": true,
    "notify_events": true,
    "notify_prayer_changes": false
  },
  {
    "id": 2,
    "email": "[email protected]",
    "notify_announcements": true,
    "notify_events": false,
    "notify_prayer_changes": true
  }
]
The /api/communications/subscribers/ path returns additional fields: 
[
  {
    "id": 1,
    "email": "[email protected]",
    "phone": "+2348012345678",
    "notify_announcements": true,
    "notify_events": true,
    "notify_prayer_changes": false,
    "is_active": true
  }
]

Build docs developers (and LLMs) love

Get started for freeTalk to us