Ihr Konto
Jede Operation in dieser Gruppe: was sie annimmt, was sie zurückgibt und mit welchen Fehlern sie antworten kann.
Operationen
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.
/account/notifications/account/notifications/email/{category}/account/notifications/push/{workspaceId}/account/photo/account/photo/account/username/account/username/account/username/availability/account/connected-apps/account/connected-apps/{clientId}/account/invitations/account/invitations/{invitationId}/accept/account/invitations/{invitationId}/decline
GET/account/notifications
Read your notification settings
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.
Rückgabe
The notification settings.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
PUT/account/notifications/email/{category}
Turn a kind of email on or off
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.
Pfadparameter
categorystringErforderlichThe kind of email.
Einer von"account""billing""activity""product"
Request-Body
enabledbooleanErforderlichTrue to receive that email, false to stop it.
Rückgabe
The notification settings as they are now.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
PUT/account/notifications/push/{workspaceId}
Mute a workspace on your phone
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.
Pfadparameter
workspaceIdstringErforderlichA workspace from
GET /workspaces.
Request-Body
mutedbooleanErforderlichTrue to mute it, false to let it notify again.
Rückgabe
The notification settings as they are now.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
PUT/account/photo
Set your profile photo
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.
Request-Body
Inhaltstypimage/png, image/jpeg, image/webp, image/gif
Rückgabe
The photo, with its new url.
Fehler
- 422
invalid_imagewhen 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.
Die Fehler, die jede Operation zurückgeben kann400401403404500Fehlerkatalog
Auch verfügbar über
DELETE/account/photo
Remove your profile photo
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.
Rückgabe
Removed, with url null.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
GET/account/username
Read your username
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.
Rückgabe
The username.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
PUT/account/username
Choose your username
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.
Request-Body
usernamestringErforderlich- Bis zu 60 Zeichen
Rückgabe
The username, now chosen.
Fehler
- 409
username_locked: the username was chosen before and never changes.username_taken: another account has it.
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
GET/account/username/availability
Check a username
Whether the person could choose a username, without choosing it. The answer says why when they could not.
Requires the account:read scope.
Query-Parameter
usernamestringErforderlichThe username to check. It is lowercased and its spaces become dots before it is checked, as the app does.
1 bis 60 Zeichen
Rückgabe
The verdict.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
GET/account/connected-apps
List your connected apps
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.
Rückgabe
The connected apps.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
DELETE/account/connected-apps/{clientId}
Remove a connected app
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.
Pfadparameter
clientIdstringErforderlichThe app's
clientIdfromGET /account/connected-apps.
Rückgabe
Removed.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
GET/account/invitations
List your invitations
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.
Rückgabe
The invitations.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
POST/account/invitations/{invitationId}/accept
Accept an invitation
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.
Pfadparameter
invitationIdstringErforderlichThe invitation id from
GET /account/invitations.
Request-Body
activateboolean
Rückgabe
Joined.
Fehler
- 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.
Die Fehler, die jede Operation zurückgeben kann400401404422500Fehlerkatalog
Auch verfügbar über
POST/account/invitations/{invitationId}/decline
Decline an invitation
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.
Pfadparameter
invitationIdstringErforderlichThe invitation id from
GET /account/invitations.
Rückgabe
Declined.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
Objekte
AcceptedInvitationobject
objectstringErforderlich- Einer von
"invitation" idstringErforderlichacceptedbooleanErforderlich- Einer von
true workspaceIdstringErforderlichworkspaceNamestringErforderlichaddressesGrantedintegerErforderlich- Mindestens 0
domainsGrantedintegerErforderlich- Mindestens 0
activatedbooleanErforderlichWhether the app now opens the workspace, after
activate: true.
AccountPhotoobject
objectstringErforderlich- Einer von
"account_photo" urlstringErforderlich- Kann null sein
ConnectedAppobject
objectstringErforderlich- Einer von
"connected_app" clientIdstringErforderlichnamestringErforderlich- Kann null sein
kindstringErforderlichclifor a sign-in of the command line tool,appfor every other app.Einer von"app""cli"cliDevicestring- Kann null sein
currentbooleanErforderlichWhether it is the app making this call.
registeredByAccountbooleanredirectUrisstring[]connectedAtstring- Kann null seinFormat
date-time accessUntilstringWhen its last token runs out.
Kann null seinFormatdate-timetokenCountintegerErforderlich- Mindestens 0
statusstringErforderlich- Einer von
"active""expired""needs-approval""access-lost" usablePermissionsintegerHow many of the permissions it was given the person still holds.
Kann null seinelevatedUntilstringUntil when it may make changes that ask for a verification code without one.
Kann null seinFormatdate-timegrantobjectWhat the person gave it, or null for an app that has to ask again.
Kann null seinworkspaceIdstringErforderlichThe one workspace the app acts for.
workspaceNamestringErforderlich- Kann null sein
permissionsstring[]ErforderlichaddressAllowliststring[]Erforderlich- Kann null sein
domainAllowliststring[]Erforderlich- Kann null sein
expiresAtstringErforderlichWhen the access ends, or null when it lasts until it is removed.
Kann null seinFormatdate-timeupdatedAtstringErforderlich- Format
date-time
ConnectedAppListobject
objectstring- Einer von
"list" dataConnectedApp[]
DeclinedInvitationobject
objectstringErforderlich- Einer von
"invitation" idstringErforderlichdeclinedbooleanErforderlich- Einer von
true
EmailNotificationSettingobject
categorystringErforderlich- Einer von
"account""billing""activity""product" labelstringErforderlichdescriptionstringErforderlichrequiredbooleanErforderlichWhether it can never be turned off.
enabledbooleanErforderlich
NotificationSettingsobject
objectstringErforderlich- Einer von
"notification_settings" emailEmailNotificationSetting[]ErforderlichEvery kind of email OpenEmail sends.
mutedWorkspacesstring[]ErforderlichThe workspaces whose notifications are muted on the phone.
ReceivedInvitationobject
objectstringErforderlich- Einer von
"invitation" idstringErforderlichworkspaceIdstringErforderlichworkspaceNamestringErforderlichroleNamestringErforderlichinviterNamestring- Kann null sein
addressesintegerErforderlichHow many addresses and whole domains it gives.
Mindestens 0expiresAtstringErforderlich- Format
date-time createdAtstringErforderlich- Format
date-time
ReceivedInvitationListobject
objectstring- Einer von
"list"
RevokedConnectedAppobject
objectstringErforderlich- Einer von
"connected_app" clientIdstringErforderlichrevokedbooleanErforderlich- Einer von
true tokensRevokedintegerErforderlich- Mindestens 0
Usernameobject
objectstringErforderlich- Einer von
"username" usernamestringErforderlich- Kann null sein
chosenbooleanErforderlichWhether the person chose it. A chosen username never changes.
addressstringErforderlichThe free address the username gives, when this deployment offers one.
Kann null sein
UsernameAvailabilityobject
objectstringErforderlich- Einer von
"username_availability" usernamestringErforderlichThe username as it was checked.
statusstringErforderlichcurrentwhen it is the username the person already has.Einer von"available""current""taken""reserved""invalid""too_short""too_long"availablebooleanErforderlichmessagestringErforderlich