Notifications

Get user notifications

The inbox: notifications that were sent (status sent, delivered or read) and are meant for it. Queued reminders and outbox-only pushes (sync nudges) are not listed. unread_count uses the same filter. Does not require completed onboarding.

get/api/notifications

Request

  • Base URL
    https://api.hiyd.ai
  • Auth
    HTTP bearer

Query parameters

status'unread' | 'read' | 'all'

Filter notifications by read status

type'health_alert' | 'goal_reminder' | 'achievement' | 'social' | 'system' | 'marketing'

Filter by notification type

pageinteger
limitinteger

Response

Notifications retrieved successfully

Changes

No recorded changes to this operation across all 1 revision of this API.