GET /messages

Display a listing of entries

Request

Query parameters

state'pending' | 'complete' | 'incomplete'

Message state

startstring date-time
Example:2021-01-30T08:30:00Z

Submitted datetime start

stopstring date-time
Example:2021-01-30T08:30:00Z

Submitted datetime end

returnstatusinteger

Filter by return status

searchstring

A word or phrase to search for.

limitinteger

Number of result per page.

pageinteger

Number of where to start returning results.

order'id' | 'userid' | 'messagequeuetypeid' | 'messagequeueoptionsid' | 'pid' | 'datetimesubmitted' | 'datetimestarted' | 'datetimecompleted' | 'returnstatus'

Field to sort results by.

order_dir'asc' | 'desc'

Direction to sort results by.

Changes

No recorded changes to this operation across all 1 revision of this API.