List reminders due in the next 30 days (organization rules)

posthttps://api.expiryedge.com/v1/getUpcomingNotifications

any role60/minJede Methode

Anfrage

curl -X POST 'https://api.expiryedge.com/v1/getUpcomingNotifications' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "selectedTeam": "0"
}'

Antwort

[
  {
    "id": "exp_4Tq9sLm2",
    "expiryName": "Northwind Dental - State Dental License",
    "expiryType": "License",
    "expiryDate": "2026-10-15",
    "nextNotification": "2026-10-08T09:00:00.000Z",
    "reminderTime": "09:00",
    "timezone": "America/Chicago",
    "daysUntilExpiry": 18,
    "reminderDaysBefore": 7,
    "reminderPeriod": "before",
    "recipients": [
      {
        "name": "Priya Shah",
        "email": "priya@northwinddental.com",
        "channels": [
          "email"
        ]
      }
    ],
    "notificationChannels": [
      "email"
    ],
    "priority": "high"
  }
]

Projects the next reminder per active expiry from the organization's reminder settings (default 1, 7 and 30 days before) within 30 days, sorted by time. Unbounded. getUpcomingNotificationsV2 reads the actual reminder queue.

Body-Parameter

application/json

selectedTeamstring
Team id; '0' or omitted = all teams.

Rückgabe

200

Upcoming notifications, soonest first.

idstring
Expiry id.
expiryNamestring
expiryTypestring
expiryDatestring
Calendar date YYYY-MM-DD in the organization's timezone.
nextNotificationstring
UTC timestamp, ISO 8601. Every v1 response uses this form, never a raw Firestore Timestamp ({_seconds, _nanoseconds}).
format: date-time
reminderTimestring
Local reminder time HH:mm.
timezonestring
IANA timezone from the organization's reminder settings (UTC by default).
daysUntilExpiryinteger
reminderDaysBeforeinteger
Days offset of the matched rule (before or after, see reminderPeriod).
reminderPeriodstring
Erlaubtbeforeafter
recipientsarray of objects
notificationChannelsarray of string
Erlaubtemailsmswhatsapp
prioritystring
critical within 7 days, high within 14, else medium.
Erlaubtcriticalhighmedium

Fehler

`400`	The request is missing required fields or contains invalid values.
`401`	Missing, expired or invalid bearer token.
`404`	The record does not exist or is not in your organization.
`429`	Too many requests for this endpoint from your IP. Wait `Retry-After` seconds.