Skip to main content
GET
/
v1
/
notifications
/
user
List User Notifications
curl --request GET \
  --url https://api.thefaithapp.com/v1/notifications/user \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <x-api-key>'
{
  "status": "<string>",
  "data": {},
  "data.current_page": 123,
  "data.data": [
    {}
  ],
  "data.data[].read_at": "<string>",
  "data.per_page": 123,
  "data.total": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.thefaithapp.com/llms.txt

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

Returns member-specific notifications such as personal alerts or direct delivery events.

Request inputs

X-API-Key
string
required
Your client API key from the dashboard (Settings page).
page
number
Page number for pagination.

Response fields

status
string
required
Indicates whether the member inbox query succeeded.
data
object
required
The paginated notification inbox for the authenticated member.
data.current_page
number
The current inbox page returned for the member.
data.data
object[]
The actual notification records shown in the member inbox.
data.data[].read_at
string
When the member read the notification, or null if it is still unread.
data.per_page
number
The maximum number of member notifications returned in this page.
data.total
number
The total number of member notifications available across all pages.

Example response

{
  "status": "Success",
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": "77211025-5c70-4847-81b3-ce242d1f9e77",
        "type": "general",
        "title": "Docs alert one",
        "body": "Seeded for API docs",
        "data": [],
        "read_at": null,
        "created_at": "2026-05-27T17:56:55.000000Z"
      }
    ],
    "per_page": 20,
    "total": 1
  }
}