Retrieve Messages

Retrieve Messages

This API endpoint enables you to retrieve a list of messages based on various query parameters. It serves as a valuable tool for efficiently accessing specific messages that match the provided filters.

To retrieve messages, make a request to this endpoint with the necessary query parameters. You can filter the results by sender and recipient employee IDs, sent timestamp, read status, limit the number of records, and specify an offset for pagination.

Query Parameters

FromEmployeeIdint32Select only messages sent from this employee.
ToEmployeeIdint32Select only messages sent to this employee.
SentFromstringSelect only messages that have been sent after this timestamp (in UTC format: yyyy-MM-ddTHH:mm)
IsReadbooleanSelect only messages that match the read status.
Limitint32Specify how many records to be included in the list. Default is 100. Max is 100.
Offsetint32Specify how many records to skip.

Example Request

GET <https://{baseUrl}/v1/Messages?FromEmployeeId=123&ToEmployeeId=456&SentFrom=2023-01-01T00:00:00Z&IsRead=true&Limit=50&Offset=10>

Explore Our API

Click Try It! to start a request and see the response here!