Skip to main content

Retrieve notification history for a party

GET 
/v1/notifications

Required States: ACTIVE, VERIFIED, PROSPECT

This endpoint retrieves the notification history for a specific party with comprehensive filtering and pagination capabilities.

Authentication & Authorization:

  • Requires valid party session (partyId from JWT)
  • Users can only access notifications for their own party context
  • Admin users can access notifications for any party using partyId parameter

Filtering Capabilities:

  • partyId: Filter by specific party (Admin only - if not provided, uses JWT partyId)
  • channelIdentifier: Filter by specific phone number, email, or device ID (masked in response for privacy)
  • messageType: Filter by MARKETING, VERIFICATION, or GENERAL notifications
  • contactChannel: Filter by SMS, EMAIL, or DEVICE notifications
  • status: Filter by NEW, DELIVERED, SCHEDULED_DELIVERY, ERROR, or CANCELLED status
  • fromDate/toDate: Filter by date range using ISO 8601 format (e.g., 2024-07-01T00:00:00Z)

Response Data:

  • Channel identifiers are masked for privacy (e.g., +614915**06, user**@domain.com)
  • Message content may be truncated or masked depending on message type and user permissions
  • Includes delivery timestamps, status information, and error details if applicable
  • Results are ordered by creation date (newest first)

Pagination:

  • Default page size: 20 items (maximum: 100)
  • Page numbers start from 1
  • Response includes pagination metadata (totalPages, totalCount, hasNext, hasPrevious)

Request​

Responses​

Notification history retrieved successfully

Last updated on