NOnovu
Messages

List all messages

Changed on

List all messages for the current environment. This API supports filtering by channel, subscriberId, and transactionId. This API returns a paginated list of messages.

get/v1/messages

Request

  • Base URL
    https://api.novu.co
  • Auth
    API key in header Authorization

Query parameters

channel'in_app' | 'email' | 'sms' | 'chat' | 'push' | 'tool'
subscriberIdstring
transactionIdstring[]
contextKeysstring[]

Filter by exact context keys, order insensitive (format: "type:id")

[
  "tenant:org-123",
  "region:us-east-1"
]
pagenumber
limitnumber

Headers

idempotency-keystring

A header for idempotency purposes

Response

totalCountnumber

Total number of messages available

hasMoreboolean required

Indicates if there are more messages available

pageSizenumber required

Number of messages per page

pagenumber required

Current page number

Changes

  • f056922796adRevision changes
    • warning

      added the new google-chat enum value to the ///////// response property for the response status

    • warning

      added the new photon-imessage enum value to the ///////// response property for the response status

  • 24e82408dec7Revision changes
    • warning

      added the new novu-web-chat enum value to the ///////// response property for the response status

    • info

      removed the novu-agent-chat enum value from the ///////// response property for the response status