Email - System Admin Inbox
List archived emails for a mailbox
List a mailbox.
folder now carries a validation pattern — an unknown value used to return an empty list rather than a 400, which is indistinguishable from an empty folder.
Both scope and the widened search default to the previous behaviour, so this endpoint can ship before the frontend that uses them.
get/api/system-admin/inbox
Query parameters
mailboxstring
Mailbox key
Mailbox key
pageinteger
page_sizeinteger
searchstring nullable
Terms AND-ed across subject / from / to / cc / preview
Terms AND-ed across subject / from / to / cc / preview
directionstring nullable
folderstring nullable
starred_onlyboolean
unread_onlyboolean
has_attachments_onlyboolean
sincestring date-time nullable
label_idinteger nullable
group_by_threadboolean
scopestring
'folder' (default) honours folder+direction; 'all' searches every folder except trash/spam.
'folder' (default) honours folder+direction; 'all' searches every folder except trash/spam.
Headers
x-api-tokenstring nullable
Response
Successful Response
{"stackTrail":"paths:/api/system-admin/inbox:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}
Changes
No recorded changes to this endpoint across all 1 revision of this API.