Skip to main content

List messages

GET 
/api/v1/notifications/messages

List message records with filtering and pagination. All query parameters are optional and may be combined. When multiple parameters are provided, filters are combined using logical AND. Common usage patterns include createdAtStart/createdAtEnd and sentAtStart/sentAtEnd, but any combination is supported.

Parameters

  • skipCount (integer, optional, default: 0): Number of records to skip
  • maxResultCount (integer, optional, default: 20): Maximum records to return
  • channelId (string, optional): Filter by channel ID (format: channel_<guid>)
  • status (string, optional): Filter by status (pending, sent, failed, partial, success)
  • createdAtStart (datetime, optional): Filter messages created on or after this time (ISO 8601, e.g. 2026-05-01T00:00:00Z)
  • createdAtEnd (datetime, optional): Filter messages created on or before this time (ISO 8601)
  • sentAtStart (datetime, optional): Filter messages sent on or after this time (ISO 8601)
  • sentAtEnd (datetime, optional): Filter messages sent on or before this time (ISO 8601)

Responses

  • 200 OK: Messages retrieved successfully.
  • 400 Bad Request: Invalid query parameter format.

Request​

Responses​

Messages retrieved successfully