Skip to main content

Get the signed-in user, accounts, and settings

GET 
/api/me

Returns everything the app needs at startup: the signed-in user (id, username, and name), their mail accounts with aliases and effective identities, and their user settings. id is the Cloudron directory id. name is the session display name.

Before answering, it refreshes the account list from the platform's list of the user's mailboxes: a new mailbox becomes a new account named after its address, aliases are updated, and accounts whose mailbox is gone are deleted. If the session has no platform access token or the platform request fails, the stored accounts are returned unchanged. This is the only call that refreshes accounts.

Needs a session, but not mailbox access.

Responses​

The user, their accounts and their settings.