FalconryScale
DevelopersAPI reference

Get notification preferences

Returns the caller's notification switches: each push toggle, its matching `_email` toggle, the push master switch, and the evening digest time (UTC). Unset switches show the app's default.

GET
/notification-preferences

Authorization

bearerAuth
headerAuthorizationBearer <token>

A Clerk user API key or OAuth access token carrying the falconry:read and/or falconry:write scope.

Response Body

Get notification preferences

application/json
  1. response
push_enabled*boolean

Master switch for mobile push notifications.

daily_weigh_in*boolean

Push: daily weigh-in reminder.

feeding_schedule*boolean

Push channel toggle.

training_sessions*boolean

Push channel toggle.

weight_alerts*boolean

Push: weight drops and out-of-range weigh-ins.

health_reminders*boolean

Push channel toggle.

compliance_alerts*boolean

Push channel toggle.

document_expiry*boolean

Push: documents about to expire.

health_checks*boolean

Push channel toggle.

community_notifications*boolean

Push channel toggle.

system_announcements*boolean

Push channel toggle.

achievement_notifications*boolean

Push channel toggle.

daily_weigh_in_email*boolean

Email channel toggle.

feeding_schedule_email*boolean

Email channel toggle.

training_sessions_email*boolean

Email channel toggle.

daily_digest_email*boolean

Email: the evening digest.

weight_alerts_email*boolean

Email channel toggle.

health_reminders_email*boolean

Email channel toggle.

compliance_alerts_email*boolean

Email channel toggle.

document_expiry_email*boolean

Email channel toggle.

health_checks_email*boolean

Email channel toggle.

community_notifications_email*boolean

Email channel toggle.

system_announcements_email*boolean

Email channel toggle.

achievement_notifications_email*boolean

Email channel toggle.

daily_digest_time_utc*|

Evening push digest time, HH:MM in UTC. null = off or never set (the app shows it off). The digest also needs feeding_schedule on.

Example Request
curl -X GET 'https://app.falconryscale.com/api/v1/notification-preferences'
Example Response
{
  "push_enabled": true,
  "daily_weigh_in": true,
  "feeding_schedule": true,
  "training_sessions": true,
  "weight_alerts": true,
  "health_reminders": true,
  "compliance_alerts": true,
  "document_expiry": true,
  "health_checks": true,
  "community_notifications": true,
  "system_announcements": true,
  "achievement_notifications": true,
  "daily_weigh_in_email": true,
  "feeding_schedule_email": true,
  "training_sessions_email": true,
  "daily_digest_email": true,
  "weight_alerts_email": true,
  "health_reminders_email": true,
  "compliance_alerts_email": true,
  "document_expiry_email": true,
  "health_checks_email": true,
  "community_notifications_email": true,
  "system_announcements_email": true,
  "achievement_notifications_email": true,
  "daily_digest_time_utc": "string"
}