Skip to main content
GET
List intramail messages

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

x-session-token
string

The App Bridge token of the logged-in user (maxcare.appToken()), verified for this app and organization. With it the request reaches that user's own mail; without it, the mail of the API key's creator. A token that does not verify is 401 authorizer_unverified. Sent as a header so GET requests keep it out of URLs.

X-Organization-Id
string
required

Target clinic organization ID

Query Parameters

folder
enum<string>
default:inbox
Available options:
inbox,
archived,
sent,
draft
patientId
string

Only messages linked to this patient (pat_…)

mailboxId
string

Mailbox (imb_…) from GET /intramail/status: one of the acting user's EHR logins. Defaults to the one marked isDefault.

page
number
default:1
Required range: x >= 1
pageSize
number
default:25
Required range: 1 <= x <= 100

Response

Success

code
string
required

Response code

Example:

"success"

data
object
required