get https://api.accountabilityone.com/v1/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
| Parameters | Type | Description |
|---|---|---|
| FromEmployeeId | int32 | Select only messages sent from this employee. |
| ToEmployeeId | int32 | Select only messages sent to this employee. |
| SentFrom | string | Select only messages that have been sent after this timestamp (in UTC format: yyyy-MM-ddTHH:mm) |
| IsRead | boolean | Select only messages that match the read status. |
| Limit | int32 | Specify how many records to be included in the list. Default is 100. Max is 100. |
| Offset | int32 | Specify 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>
Permission
| Transaction Type | Access Level |
|---|---|
| Messages | Full Access, Read Only |