GetSubscriptions

post

https://{yourlidiaurl}/notification/query/subscriptions

Retrieves a list of active subscriptions based on the provided query filters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The query parameters to filter subscriptions.

Represents the query parameters for filtering subscriptions.

subscriptionIds

array | null

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

subscriptionIds

eventIds

array | null

Gets or sets the list of event identifiers associated with the subscription to filter by.

eventIds

recipientIds

array | null

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

recipientIds

addresses

array of strings | null

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

addresses

channels

array of objects | null

Gets or sets the list of channel mediums (e.g. Email, SMS) to filter by.

channels

Allowed:

environment

string | null

Gets or sets the execution environment name.

applicationIP

string | null

Gets or sets the IP address of the calling application.

tenantId

string

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

Gets or sets the identifier of the tenant context.

userToken

string | null

Gets or sets the authentication token of the active user.

sessionId

string | null

Gets or sets the unique session identifier.

userId

string

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

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

userIP

string | null

Gets or sets the IP address of the active user.

envelope

string | null

Gets or sets the request envelope payload.

threadId

string | null

Gets or sets the correlation thread identifier.

debugMode

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

searchKey

string | null

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

pageIndex

string

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

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

pageSize

string

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

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

sorting

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:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200A response containing the list of matching subscriptions.