Votre compte
Chaque opération de ce groupe : ce qu'elle accepte, ce qu'elle retourne et les erreurs qu'elle peut renvoyer.
Opérations
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.
Retourne
The notification settings.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
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.
Paramètres de chemin
categorystringObligatoireThe kind of email.
L'un de"account""billing""activity""product"
Corps de la requête
enabledbooleanObligatoireTrue to receive that email, false to stop it.
Retourne
The notification settings as they are now.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
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.
Paramètres de chemin
workspaceIdstringObligatoireA workspace from
GET /workspaces.
Corps de la requête
mutedbooleanObligatoireTrue to mute it, false to let it notify again.
Retourne
The notification settings as they are now.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
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.
Corps de la requête
Type de contenuimage/png, image/jpeg, image/webp, image/gif
Retourne
The photo, with its new url.
Erreurs
- 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.
Les erreurs que toute opération peut renvoyer400401403404500Catalogue des erreurs
Aussi disponible dans
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.
Retourne
Removed, with url null.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
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.
Retourne
The username.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
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.
Corps de la requête
usernamestringObligatoire- Jusqu'à 60 caractères
Retourne
The username, now chosen.
Erreurs
- 409
username_locked: the username was chosen before and never changes.username_taken: another account has it.
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
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.
Paramètres de requête
usernamestringObligatoireThe username to check. It is lowercased and its spaces become dots before it is checked, as the app does.
De 1 à 60 caractères
Retourne
The verdict.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
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.
Retourne
The connected apps.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
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.
Paramètres de chemin
clientIdstringObligatoireThe app's
clientIdfromGET /account/connected-apps.
Retourne
Removed.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
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.
Retourne
The invitations.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
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.
Paramètres de chemin
invitationIdstringObligatoireThe invitation id from
GET /account/invitations.
Corps de la requête
activateboolean
Retourne
Joined.
Erreurs
- 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.
Les erreurs que toute opération peut renvoyer400401404422500Catalogue des erreurs
Aussi disponible dans
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.
Paramètres de chemin
invitationIdstringObligatoireThe invitation id from
GET /account/invitations.
Retourne
Declined.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
Objets
AcceptedInvitationobject
objectstringObligatoire- L'un de
"invitation" idstringObligatoireacceptedbooleanObligatoire- L'un de
true workspaceIdstringObligatoireworkspaceNamestringObligatoireaddressesGrantedintegerObligatoire- Au moins 0
domainsGrantedintegerObligatoire- Au moins 0
activatedbooleanObligatoireWhether the app now opens the workspace, after
activate: true.
AccountPhotoobject
objectstringObligatoire- L'un de
"account_photo" urlstringObligatoire- Peut être null
ConnectedAppobject
objectstringObligatoire- L'un de
"connected_app" clientIdstringObligatoirenamestringObligatoire- Peut être null
kindstringObligatoireclifor a sign-in of the command line tool,appfor every other app.L'un de"app""cli"cliDevicestring- Peut être null
currentbooleanObligatoireWhether it is the app making this call.
registeredByAccountbooleanredirectUrisstring[]connectedAtstring- Peut être nullFormat
date-time accessUntilstringWhen its last token runs out.
Peut être nullFormatdate-timetokenCountintegerObligatoire- Au moins 0
statusstringObligatoire- L'un de
"active""expired""needs-approval""access-lost" usablePermissionsintegerHow many of the permissions it was given the person still holds.
Peut être nullelevatedUntilstringUntil when it may make changes that ask for a verification code without one.
Peut être nullFormatdate-timegrantobjectWhat the person gave it, or null for an app that has to ask again.
Peut être nullworkspaceIdstringObligatoireThe one workspace the app acts for.
workspaceNamestringObligatoire- Peut être null
permissionsstring[]ObligatoireaddressAllowliststring[]Obligatoire- Peut être null
domainAllowliststring[]Obligatoire- Peut être null
expiresAtstringObligatoireWhen the access ends, or null when it lasts until it is removed.
Peut être nullFormatdate-timeupdatedAtstringObligatoire- Format
date-time
ConnectedAppListobject
objectstring- L'un de
"list" dataConnectedApp[]
DeclinedInvitationobject
objectstringObligatoire- L'un de
"invitation" idstringObligatoiredeclinedbooleanObligatoire- L'un de
true
EmailNotificationSettingobject
categorystringObligatoire- L'un de
"account""billing""activity""product" labelstringObligatoiredescriptionstringObligatoirerequiredbooleanObligatoireWhether it can never be turned off.
enabledbooleanObligatoire
NotificationSettingsobject
objectstringObligatoire- L'un de
"notification_settings" emailEmailNotificationSetting[]ObligatoireEvery kind of email OpenEmail sends.
mutedWorkspacesstring[]ObligatoireThe workspaces whose notifications are muted on the phone.
ReceivedInvitationobject
objectstringObligatoire- L'un de
"invitation" idstringObligatoireworkspaceIdstringObligatoireworkspaceNamestringObligatoireroleNamestringObligatoireinviterNamestring- Peut être null
addressesintegerObligatoireHow many addresses and whole domains it gives.
Au moins 0expiresAtstringObligatoire- Format
date-time createdAtstringObligatoire- Format
date-time
ReceivedInvitationListobject
objectstring- L'un de
"list"
RevokedConnectedAppobject
objectstringObligatoire- L'un de
"connected_app" clientIdstringObligatoirerevokedbooleanObligatoire- L'un de
true tokensRevokedintegerObligatoire- Au moins 0
Usernameobject
objectstringObligatoire- L'un de
"username" usernamestringObligatoire- Peut être null
chosenbooleanObligatoireWhether the person chose it. A chosen username never changes.
addressstringObligatoireThe free address the username gives, when this deployment offers one.
Peut être null
UsernameAvailabilityobject
objectstringObligatoire- L'un de
"username_availability" usernamestringObligatoireThe username as it was checked.
statusstringObligatoirecurrentwhen it is the username the person already has.L'un de"available""current""taken""reserved""invalid""too_short""too_long"availablebooleanObligatoiremessagestringObligatoire