API Reference
  1. Lidia Notification
  2. Query > Notifications > Notifications

GetNotifications

post
https://{yourlidiaurl}/notification/query/notifications

Retrieves a list of historical notifications based on the provided query filters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The query parameters to filter notifications.

Represents the query parameters for filtering notifications.

notificationIds
array | null

Gets or sets the list of notification identifiers to filter by.

notificationIds
recipientIds
array | null

Gets or sets the list of recipient identifiers to filter by.

recipientIds
recipientAddresses
array of strings | null

Gets or sets the list of recipient address strings (e.g. emails, phone numbers) to filter by.

recipientAddresses
subjects
array of strings | null

Gets or sets the list of subjects to filter by.

subjects
recipientTypes
array of objects | null

Gets or sets the list of recipient classification types (e.g. To, Cc, Bcc) to filter by.

recipientTypes
states
array of objects | null

Gets or sets the list of delivery states (e.g. Sent, Pending, Failed) to filter by.

states
types
array of objects | null

Gets or sets the list of notification type categories (e.g. Email, SMS) to filter by.

types
Allowed:
eventTypes
array of objects | null

Gets or sets the list of lifecycle event types associated with the notification to filter by.

eventTypes
date-time | null

Gets or sets the start date boundary for the creation timestamp filter.

date-time | null

Gets or sets the end date boundary for the creation timestamp filter.

boolean

Gets or sets a value indicating whether to perform query matching on the JSON data field.

string | null

Gets or sets the name of the target key inside the JSON metadata field to query.

fieldValue
array of strings | null

Gets or sets the list of allowed values for the target JSON key.

fieldValue
string | null

Gets or sets the execution environment name.

string | null

Gets or sets the IP address of the calling application.

string
^-?(?:0|[1-9]\d*)$

Gets or sets the identifier of the tenant context.

string | null

Gets or sets the authentication token of the active user.

string | null

Gets or sets the unique session identifier.

string
^-?(?:0|[1-9]\d*)$

Gets or sets the identifier of the user initiating the request.

string | null

Gets or sets the IP address of the active user.

string | null

Gets or sets the request envelope payload.

string | null

Gets or sets the correlation thread identifier.

string | null

Gets or sets the debug mode flag or options.

includes
array of strings | null

Gets or sets the related entities to include in the query result.

includes
string | null

Gets or sets the key term or expression used to filter search results.

string
^-?(?:0|[1-9]\d*)$

Gets or sets the page index for paginated results (1-based).

string
^-?(?:0|[1-9]\d*)$

Gets or sets the maximum number of items to return in a single page.

string | null

Gets or sets the sort configuration string (e.g. 'FieldName DESC').

status
array of objects | null

Gets or sets the entity status filters.

status
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Response

Updated 18 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 18 days ago

Did this page help you?