Notifications API

Endpoints for managing notifications and user preferences.

Get Notifications

Retrieve user notifications.

curl -X GET "https://api.usmewe.com/v1/notifications?limit=20" \
  -H "Authorization: Bearer YOUR_TOKEN"

Query Parameters

Parameter	Type	Description
`limit`	number	Results per page (default: 20)
`offset`	number	Pagination offset
`unread`	boolean	Filter unread only
`type`	string	Filter by notification type

Get Unread Count

Get count of unread notifications.

curl -X GET "https://api.usmewe.com/v1/notifications/unread/count" \
  -H "Authorization: Bearer YOUR_TOKEN"

Mark as Read

Mark notifications as read.

Single Notification

curl -X PATCH "https://api.usmewe.com/v1/notifications/{notifId}/read" \
  -H "Authorization: Bearer YOUR_TOKEN"

Mark All Read

curl -X POST "https://api.usmewe.com/v1/notifications/read-all" \
  -H "Authorization: Bearer YOUR_TOKEN"

Delete Notification

Delete a notification.

curl -X DELETE "https://api.usmewe.com/v1/notifications/{notifId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Notification Types

Type	Description
`loan_created`	Loan request created
`loan_funded`	Loan has been funded
`loan_due_reminder`	Payment due reminder
`loan_overdue`	Loan is overdue
`loan_repaid`	Loan successfully repaid
`guardian_request`	Guardian invitation received
`guardian_accepted`	Guardian accepted invitation
`withdrawal_requested`	Social Vault withdrawal pending
`withdrawal_approval_needed`	Guardian approval needed
`vault_locked`	Social Vault locked (duress)
`trust_score_updated`	Trust Score changed
`level_up`	User leveled up
`badge_earned`	New badge earned

Notification Preferences

Get Preferences

curl -X GET "https://api.usmewe.com/v1/notifications/preferences" \
  -H "Authorization: Bearer YOUR_TOKEN"

Update Preferences

curl -X PATCH "https://api.usmewe.com/v1/notifications/preferences" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "push": {
      "marketing": false
    },
    "email": {
      "weekly_summary": false
    }
  }'

Register Push Token

curl -X POST "https://api.usmewe.com/v1/notifications/push/register" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "ExponentPushToken[xxx]",
    "platform": "ios",
    "deviceId": "device_abc123"
  }'

Unregister Push Token

Remove device from push notifications.

curl -X DELETE "https://api.usmewe.com/v1/notifications/push/unregister" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "deviceId": "device_abc123"
  }'

Test Notification

Send a test notification (development only).

curl -X POST "https://api.usmewe.com/v1/notifications/test" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "push"
  }'

Error Responses

Code	Error	Description
404	`NOTIFICATION_NOT_FOUND`	Notification doesn’t exist
400	`INVALID_TOKEN`	Invalid push token format
429	`RATE_LIMITED`	Too many requests

API Overview

API Endpoints

​Notifications API

​Get Notifications

​Query Parameters

​Get Unread Count

​Mark as Read

​Single Notification

​Mark All Read

​Delete Notification

​Notification Types

​Notification Preferences

​Get Preferences

​Update Preferences

​Register Push Token

​Unregister Push Token

​Test Notification

​Error Responses