Zen ERPInstall

Summary

Retrieve messages from the System/Integration endpoint applying optional query parameters for filtering, ordering, and pagination.

Inputs

• q — String used to filter or search messages matching this query.
• order — String to specify the ordering of returned messages.
• first — Number indicating the index of the first message to return (offset).
• max — Maximum number of messages to return.

Output shape

a list of message objects matching the query parameters

The operation returns an array of JSON objects where each item corresponds to a message record retrieved from the System/Integration service. Pagination and filtering apply as per provided query parameters. Errors are returned within the item JSON under an error key if 'Continue on Fail' is enabled.

Examples

Example 1: Fetch first 10 messages matching a search term

Set 'q' to the search string, 'first' to 0, and 'max' to 10 to retrieve the first ten messages matching the query.