Skip to main content
GET
Search intramail recipients

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

query
string
required

Name to search, at least 2 characters

Required string length: 2 - 100
mailboxId
string

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

Response

Success

code
string
required

Response code

Example:

"success"

data
object
required