ドキュメント本文へスキップ
API

あなたのアカウント

このグループのすべてのオペレーションの、受け付ける内容、返す内容、返しうるエラー。

オペレーション

The account of the person behind the key or the app: which email notifications they get, their profile photo and username, the apps they connected and the invitations waiting for them. These calls act on a person, never on a workspace: an API key acts for the workspace owner, and an app for the person who connected it. Reading needs account:read and every change needs account:write. Neither is ever limited by a role, so an app a member connected reaches the member's own account too.

GET/account/notifications

Read your notification settings

スコープaccount:read読み取り

Which kinds of email OpenEmail sends the person, as Account, Notifications shows them, and the workspaces whose notifications are muted on their phone. Account and billing email cannot be turned off.

Requires the account:read scope.

戻り値

The notification settings.

エラー

どのオペレーションも返しうるエラー400401403404422500エラー一覧

ほかの提供先

SDK
account.getNotifications()
CLI
openemail account get-notifications
MCP
getNotificationSettings

PUT/account/notifications/email/{category}

Turn a kind of email on or off

スコープaccount:writeデータを変更

enabled: false stops OpenEmail sending the person that kind of email, and true starts it again. account and billing cannot be turned off, and asking to is a 422 invalid_parameter on category.

Requires the account:write scope.

パスパラメーター

categorystring必須

The kind of email.

次のいずれか"account""billing""activity""product"

リクエストボディ

enabledboolean必須

True to receive that email, false to stop it.

戻り値

The notification settings as they are now.

エラー

どのオペレーションも返しうるエラー400401403404422500エラー一覧

ほかの提供先

SDK
account.setEmailNotification()
CLI
openemail account set-email-notification
MCP
setEmailNotification

PUT/account/notifications/push/{workspaceId}

Mute a workspace on your phone

スコープaccount:writeデータを変更

muted: true stops the phone app notifying the person about the mail of one workspace, and false lets it notify them again. It applies to every phone they signed in on. A workspace they cannot open is a 404.

Requires the account:write scope.

パスパラメーター

workspaceIdstring必須

A workspace from GET /workspaces.

リクエストボディ

mutedboolean必須

True to mute it, false to let it notify again.

戻り値

The notification settings as they are now.

エラー

どのオペレーションも返しうるエラー400401403404422500エラー一覧

ほかの提供先

SDK
account.setPushMuted()
CLI
openemail account set-push-muted
MCP
setWorkspacePushMuted

PUT/account/photo

Set your profile photo

スコープaccount:writeデータを変更

Uploads the person's profile photo, replacing any there was, as Account, Profile does. Send the image itself as the body, not JSON, with its type in Content-Type: image/png, image/jpeg, image/webp, image/gif. Up to 5 MB goes in. It is fitted into a 512 pixel square and stored as WebP, and an animated image keeps its first frame.

Requires the account:write scope.

リクエストボディ

コンテンツタイプimage/png, image/jpeg, image/webp, image/gif

binary

戻り値

The photo, with its new url.

エラー

422

invalid_image when the body is not an image of an accepted type, is too large or cannot be read.

502

image_not_stored: the image was read but could not be stored. Try again.

503

image_busy: the image service is saturated. Try again shortly.

どのオペレーションも返しうるエラー400401403404500エラー一覧

ほかの提供先

SDK
account.setPhoto()
CLI
openemail account set-photo
MCP
setProfilePhoto

DELETE/account/photo

Remove your profile photo

スコープaccount:write削除

Removes the profile photo and deletes the stored image, so the app shows initials again. Removing it when there is none changes nothing.

Requires the account:write scope.

戻り値

Removed, with url null.

エラー

どのオペレーションも返しうるエラー400401403404422500エラー一覧

ほかの提供先

SDK
account.removePhoto()
CLI
openemail account remove-photo
MCP
removeProfilePhoto

GET/account/username

Read your username

スコープaccount:read読み取り

The username of the person, whether they chose it or it was made for them, and the free address it gives them. A username is made from their name the first time it is read.

Requires the account:read scope.

戻り値

The username.

エラー

どのオペレーションも返しうるエラー400401403404422500エラー一覧

ほかの提供先

SDK
account.getUsername()
CLI
openemail account get-username
MCP
getUsername

PUT/account/username

Choose your username

スコープaccount:writeデータを変更

Sets the username for good, and with it the free address. Once chosen it never changes: a second choice is a 409 username_locked. A username another account has is a 409 username_taken, and one that is too short, too long, reserved or not lowercase letters, numbers and single dots is a 422 invalid_parameter on username. Check one first with GET /account/username/availability.

Requires the account:write scope.

リクエストボディ

usernamestring必須
60文字まで

戻り値

The username, now chosen.

エラー

409

username_locked: the username was chosen before and never changes. username_taken: another account has it.

どのオペレーションも返しうるエラー400401403404422500エラー一覧

ほかの提供先

SDK
account.setUsername()
CLI
openemail account set-username
MCP
chooseUsername

GET/account/username/availability

Check a username

スコープaccount:read読み取り

Whether the person could choose a username, without choosing it. The answer says why when they could not.

Requires the account:read scope.

クエリパラメーター

usernamestring必須

The username to check. It is lowercased and its spaces become dots before it is checked, as the app does.

1〜60文字

戻り値

The verdict.

エラー

どのオペレーションも返しうるエラー400401403404422500エラー一覧

ほかの提供先

SDK
account.checkUsername()
CLI
openemail account check-username
MCP
checkUsername

GET/account/connected-apps

List your connected apps

スコープaccount:read読み取り

Every app the person connected with OAuth, as Account, Connected apps lists them: what each may reach, until when, how many tokens it holds and whether changes are allowed without a code for it right now. current marks the app making the call. Changing what an app may reach is done in the app, never through an app.

Requires the account:read scope.

戻り値

The connected apps.

エラー

どのオペレーションも返しうるエラー400401403404422500エラー一覧

ほかの提供先

SDK
account.listConnectedApps()
CLI
openemail account list-connected-apps
MCP
listConnectedApps

DELETE/account/connected-apps/{clientId}

Remove a connected app

スコープaccount:write削除

Deletes every token the app holds and the access the person gave it, so its next call is refused and it has to ask again. Removing the app making the call disconnects it. An app the person never connected is a 404.

Requires the account:write scope.

パスパラメーター

clientIdstring必須

The app's clientId from GET /account/connected-apps.

戻り値

エラー

どのオペレーションも返しうるエラー400401403404422500エラー一覧

ほかの提供先

SDK
account.revokeConnectedApp()
CLI
openemail account revoke-connected-app
MCP
revokeConnectedApp

GET/account/invitations

List your invitations

スコープaccount:read読み取り

The invitations to join a workspace waiting for the address the person signs in with, oldest first. Expired, accepted and withdrawn ones are left out.

Requires the account:read scope.

戻り値

The invitations.

エラー

どのオペレーションも返しうるエラー400401403404422500エラー一覧

ほかの提供先

SDK
account.listInvitations()
CLI
openemail account list-invitations
MCP
listReceivedInvitations

POST/account/invitations/{invitationId}/accept

Accept an invitation

スコープaccount:writeデータを変更

Joins the workspace with the role and the addresses the invitation gives, as accepting it in the app or from its link does. activate: true also makes it the workspace the app opens. A workspace that asks for two-factor sign-in is a 403 two_factor_required until the person turns it on, and an invitation that expired, was withdrawn or went to another address is a 422.

Requires the account:write scope.

パスパラメーター

invitationIdstring必須

The invitation id from GET /account/invitations.

リクエストボディ

activateboolean

戻り値

エラー

403

two_factor_required: the workspace asks everyone in it to sign in with two-factor authentication. mailbox_login: a password sign-in for one address cannot join a workspace.

どのオペレーションも返しうるエラー400401404422500エラー一覧

ほかの提供先

SDK
account.acceptInvitation()
CLI
openemail account accept-invitation
MCP
acceptInvitation

POST/account/invitations/{invitationId}/decline

Decline an invitation

スコープaccount:write削除

Turns the invitation down, so its link stops working, and tells whoever sent it. It cannot be taken back: they have to invite the person again. An invitation they already accepted is a 409 invitation_accepted.

Requires the account:write scope.

パスパラメーター

invitationIdstring必須

The invitation id from GET /account/invitations.

戻り値

Declined.

エラー

どのオペレーションも返しうるエラー400401403404422500エラー一覧

ほかの提供先

SDK
account.declineInvitation()
CLI
openemail account decline-invitation
MCP
declineInvitation

オブジェクト

AcceptedInvitationobject

objectstring必須
次のいずれか"invitation"
idstring必須
acceptedboolean必須
次のいずれかtrue
workspaceIdstring必須
workspaceNamestring必須
addressesGrantedinteger必須
0以上
domainsGrantedinteger必須
0以上
activatedboolean必須

Whether the app now opens the workspace, after activate: true.

AccountPhotoobject

objectstring必須
次のいずれか"account_photo"
urlstring必須
null も可

ConnectedAppobject

objectstring必須
次のいずれか"connected_app"
clientIdstring必須
namestring必須
null も可
kindstring必須

cli for a sign-in of the command line tool, app for every other app.

次のいずれか"app""cli"
cliDevicestring
null も可
currentboolean必須

Whether it is the app making this call.

registeredByAccountboolean
redirectUrisstring[]
connectedAtstring
null も可形式date-time
accessUntilstring

When its last token runs out.

null も可形式date-time
tokenCountinteger必須
0以上
statusstring必須
次のいずれか"active""expired""needs-approval""access-lost"
usablePermissionsinteger

How many of the permissions it was given the person still holds.

null も可
elevatedUntilstring

Until when it may make changes that ask for a verification code without one.

null も可形式date-time
grantobject

What the person gave it, or null for an app that has to ask again.

null も可
workspaceIdstring必須

The one workspace the app acts for.

workspaceNamestring必須
null も可
permissionsstring[]必須
addressAllowliststring[]必須
null も可
domainAllowliststring[]必須
null も可
expiresAtstring必須

When the access ends, or null when it lasts until it is removed.

null も可形式date-time
updatedAtstring必須
形式date-time

ConnectedAppListobject

objectstring
次のいずれか"list"

DeclinedInvitationobject

objectstring必須
次のいずれか"invitation"
idstring必須
declinedboolean必須
次のいずれかtrue

EmailNotificationSettingobject

categorystring必須
次のいずれか"account""billing""activity""product"
labelstring必須
descriptionstring必須
requiredboolean必須

Whether it can never be turned off.

enabledboolean必須

NotificationSettingsobject

objectstring必須
次のいずれか"notification_settings"
emailEmailNotificationSetting[]必須

Every kind of email OpenEmail sends.

mutedWorkspacesstring[]必須

The workspaces whose notifications are muted on the phone.

ReceivedInvitationobject

objectstring必須
次のいずれか"invitation"
idstring必須
workspaceIdstring必須
workspaceNamestring必須
roleNamestring必須
inviterNamestring
null も可
addressesinteger必須

How many addresses and whole domains it gives.

0以上
expiresAtstring必須
形式date-time
createdAtstring必須
形式date-time

RevokedConnectedAppobject

objectstring必須
次のいずれか"connected_app"
clientIdstring必須
revokedboolean必須
次のいずれかtrue
tokensRevokedinteger必須
0以上

Usernameobject

objectstring必須
次のいずれか"username"
usernamestring必須
null も可
chosenboolean必須

Whether the person chose it. A chosen username never changes.

addressstring必須

The free address the username gives, when this deployment offers one.

null も可

UsernameAvailabilityobject

objectstring必須
次のいずれか"username_availability"
usernamestring必須

The username as it was checked.

statusstring必須

current when it is the username the person already has.

次のいずれか"available""current""taken""reserved""invalid""too_short""too_long"
availableboolean必須
messagestring必須