queryRecipients( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of recipients with optional filtering, sorting, and paging.

Up to 100 recipients can be returned per request.

For a detailed list of supported operations, see the Supported Filters and Sorting article. To learn how to query notification recipients, see API Query Language.

Supported properties for filtering and sorting: id, createdDate, updatedDate, channels

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
_createdDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
_updatedDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
phoneeq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
businessLocationIdseq(),ne(),exists(),in(),hasSome(),hasAll(),ascending(),descending()
channelsascending(),descending()
tags.privateTags.tagIdseq(),ne(),exists(),in(),hasSome(),hasAll(),ascending(),descending()
tags.publicTags.tagIdseq(),ne(),exists(),in(),hasSome(),hasAll(),ascending(),descending()
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?