Sign in
scheduled-notifications

Get all scheduled notifications

Retrieve a list of scheduled notifications with optional filters. You can filter by status, target type, date range, and limit the number of results.

get/notifications/scheduled

Query parameters

status'pending_approval' | 'pending' | 'processing' | 'sent' | 'failed' | 'cancelled' | 'expired' | 'rejected'
Example:pending

Filter by status

targetType'user' | 'users' | 'all_users' | 'tokens' | 'topic' | 'condition'
Example:all_users

Filter by target type

fromDatestring
Example:2025-12-01T00:00:00Z

Filter notifications scheduled from this date

toDatestring
Example:2025-12-31T23:59:59Z

Filter notifications scheduled to this date

limitnumber
Example:50

Maximum number of results to return

Response

List of scheduled notifications retrieved successfully

notification_idnumber required

Notification ID

titlestring required

Notification title

bodystring required

Notification body

scheduled_timestring date-time required

Scheduled time

timezonestring required

Timezone

target_type'user' | 'users' | 'all_users' | 'tokens' | 'topic' | 'condition' required

Target type

target_valueobject

Target value

status'pending_approval' | 'pending' | 'processing' | 'sent' | 'failed' | 'cancelled' | 'expired' | 'rejected' required

Current status

sent_atstring date-time

Sent timestamp

success_countnumber required

Number of successful sends

failure_countnumber required

Number of failed sends

error_messagestring

Error message if failed

created_atstring date-time required

Created timestamp

updated_atstring date-time required

Updated timestamp

Example response

[
  {
    "notification_id": 1,
    "title": "Flash Sale Alert",
    "body": "Get 50% off!",
    "scheduled_time": "2025-12-25T10:00:00Z",
    "timezone": "Asia/Kuala_Lumpur",
    "target_type": "all_users",
    "status": "pending",
    "created_at": "2025-12-01T10:00:00Z",
    "updated_at": "2025-12-01T10:00:00Z"
  }
]

Changes

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