The Open API specification for Synapse is now available for download!

Download Open API Spec

GET /message/inbox

Retrieves the current authenticated user's inbox. It may take several seconds for a message to appear in the inbox after creation.
By default, the most recent unread messages are returned first. To flip the ordering, set the "descending" parameter to "false". To change the way the messages are ordered, set the "orderBy" parameter to either "SEND_DATE" or "SUBJECT". To retrieve messages that have been read or archived, set the "inboxFilter" parameter to a comma-separated list of values defined in the MessageStatusType enumeration.

Resource URL

https://repo-prod.prod.sagebase.org/repo/v1/message/inbox

Parameters
inboxFilter

optional

orderBy

optional

descending

optional

limit

optional

offset

optional

Resource Information
Authentication Required
Required OAuth Scopes view
HTTP Method GET
Request Object None
Response Object PaginatedResults<MessageBundle>
(application/json)