Retrieve a specific notification by ID

GET 
/v1/notifications/:notificationId

Required States: ACTIVE, VERIFIED, PROSPECT

This endpoint retrieves the detailed information of a specific notification using its external identifier.

Authentication & Authorization:

• Requires valid party session (partyId from JWT)
• Users can only access notifications that belong to their own party context
• Admin users can access any notification regardless of party ownership

Response Data:

• Includes full notification details including message content, delivery status, and metadata
• Channel identifiers are masked for privacy (e.g., +614915****06)
• Template information is included if the notification was sent using a template
• Error details are provided if the notification failed to deliver
• Delivery receipts from external providers are included when available

Security Considerations:

• Message content may be sanitized or masked depending on the notification type and user permissions
• External provider identifiers are included for audit and debugging purposes
• All access is logged for security and compliance purposes

Request

Responses

200

Notification details retrieved successfully

401

Missing or invalid authentication token (GEN001002) or Role unauthorized (GEN001006) or Tenant context could not be resolved (AUT001001)

403

External application access denied (AUT003001) or Party not in required status (PAR003001)

404

Party not found (PAR004001) or No open binding for the notification (CRT004005) or Notification not found (NOT004001)

500

General internal server error (GEN100000) or Service error (GEN100001)

503

All connector targets are currently unhealthy (CRT103001)