Sign in
Messages

List all messages

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

Query parameters

channel'in_app' | 'email' | 'sms' | 'chat' | 'push' | 'tool'

Channel type through which the message is sent

subscriberIdstring
transactionIdstring[]
contextKeysstring[]

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

pagenumber
limitnumber

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

Changed in 4 of the 13 revisions of this API.74

  • 8bc1670bbd1311See the full diff
    • ●

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

      response-property-enum-value-added

    • ○

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

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d7137c47680a11See the full diff
    • ●

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

      response-property-enum-value-added

    • ○

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

      response-property-enum-value-removed

  • 47f16ff4d4271See the full diff
    • ●

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

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2e115ea8160c42See the full diff
    • ●

      added the new line enum value to the ///////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new sendblue enum value to the ///////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new tool enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new webex-messaging enum value to the ///////// response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value tool to the query request parameter channel

      request-parameter-enum-value-added

    • ○

      added the optional property //////// to the response with the status

      response-optional-property-added