A sua conta
Cada operação deste grupo: o que aceita, o que devolve e os erros com que pode responder.
Operações
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.
Devolve
The notification settings.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
categorystringObrigatórioThe kind of email.
Um de"account""billing""activity""product"
Corpo do pedido
enabledbooleanObrigatórioTrue to receive that email, false to stop it.
Devolve
The notification settings as they are now.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
workspaceIdstringObrigatórioA workspace from
GET /workspaces.
Corpo do pedido
mutedbooleanObrigatórioTrue to mute it, false to let it notify again.
Devolve
The notification settings as they are now.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Corpo do pedido
Tipo de conteúdoimage/png, image/jpeg, image/webp, image/gif
Devolve
The photo, with its new url.
Erros
- 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.
Os erros que qualquer operação pode devolver400401403404500Catálogo de erros
Também disponível em
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.
Devolve
Removed, with url null.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Devolve
The username.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Corpo do pedido
usernamestringObrigatório- Até 60 caracteres
Devolve
The username, now chosen.
Erros
- 409
username_locked: the username was chosen before and never changes.username_taken: another account has it.
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Parâmetros de consulta
usernamestringObrigatórioThe username to check. It is lowercased and its spaces become dots before it is checked, as the app does.
De 1 a 60 caracteres
Devolve
The verdict.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Devolve
The connected apps.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
clientIdstringObrigatórioThe app's
clientIdfromGET /account/connected-apps.
Devolve
Removed.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Devolve
The invitations.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
invitationIdstringObrigatórioThe invitation id from
GET /account/invitations.
Corpo do pedido
activateboolean
Devolve
Joined.
Erros
- 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.
Os erros que qualquer operação pode devolver400401404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
invitationIdstringObrigatórioThe invitation id from
GET /account/invitations.
Devolve
Declined.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
Objetos
AcceptedInvitationobject
objectstringObrigatório- Um de
"invitation" idstringObrigatórioacceptedbooleanObrigatório- Um de
true workspaceIdstringObrigatórioworkspaceNamestringObrigatórioaddressesGrantedintegerObrigatório- Pelo menos 0
domainsGrantedintegerObrigatório- Pelo menos 0
activatedbooleanObrigatórioWhether the app now opens the workspace, after
activate: true.
AccountPhotoobject
objectstringObrigatório- Um de
"account_photo" urlstringObrigatório- Pode ser null
ConnectedAppobject
objectstringObrigatório- Um de
"connected_app" clientIdstringObrigatórionamestringObrigatório- Pode ser null
kindstringObrigatórioclifor a sign-in of the command line tool,appfor every other app.Um de"app""cli"cliDevicestring- Pode ser null
currentbooleanObrigatórioWhether it is the app making this call.
registeredByAccountbooleanredirectUrisstring[]connectedAtstring- Pode ser nullFormato
date-time accessUntilstringWhen its last token runs out.
Pode ser nullFormatodate-timetokenCountintegerObrigatório- Pelo menos 0
statusstringObrigatório- Um de
"active""expired""needs-approval""access-lost" usablePermissionsintegerHow many of the permissions it was given the person still holds.
Pode ser nullelevatedUntilstringUntil when it may make changes that ask for a verification code without one.
Pode ser nullFormatodate-timegrantobjectWhat the person gave it, or null for an app that has to ask again.
Pode ser nullworkspaceIdstringObrigatórioThe one workspace the app acts for.
workspaceNamestringObrigatório- Pode ser null
permissionsstring[]ObrigatórioaddressAllowliststring[]Obrigatório- Pode ser null
domainAllowliststring[]Obrigatório- Pode ser null
expiresAtstringObrigatórioWhen the access ends, or null when it lasts until it is removed.
Pode ser nullFormatodate-timeupdatedAtstringObrigatório- Formato
date-time
ConnectedAppListobject
objectstring- Um de
"list" dataConnectedApp[]
DeclinedInvitationobject
objectstringObrigatório- Um de
"invitation" idstringObrigatóriodeclinedbooleanObrigatório- Um de
true
EmailNotificationSettingobject
categorystringObrigatório- Um de
"account""billing""activity""product" labelstringObrigatóriodescriptionstringObrigatóriorequiredbooleanObrigatórioWhether it can never be turned off.
enabledbooleanObrigatório
NotificationSettingsobject
objectstringObrigatório- Um de
"notification_settings" emailEmailNotificationSetting[]ObrigatórioEvery kind of email OpenEmail sends.
mutedWorkspacesstring[]ObrigatórioThe workspaces whose notifications are muted on the phone.
ReceivedInvitationobject
objectstringObrigatório- Um de
"invitation" idstringObrigatórioworkspaceIdstringObrigatórioworkspaceNamestringObrigatórioroleNamestringObrigatórioinviterNamestring- Pode ser null
addressesintegerObrigatórioHow many addresses and whole domains it gives.
Pelo menos 0expiresAtstringObrigatório- Formato
date-time createdAtstringObrigatório- Formato
date-time
ReceivedInvitationListobject
objectstring- Um de
"list"
RevokedConnectedAppobject
objectstringObrigatório- Um de
"connected_app" clientIdstringObrigatóriorevokedbooleanObrigatório- Um de
true tokensRevokedintegerObrigatório- Pelo menos 0
Usernameobject
objectstringObrigatório- Um de
"username" usernamestringObrigatório- Pode ser null
chosenbooleanObrigatórioWhether the person chose it. A chosen username never changes.
addressstringObrigatórioThe free address the username gives, when this deployment offers one.
Pode ser null
UsernameAvailabilityobject
objectstringObrigatório- Um de
"username_availability" usernamestringObrigatórioThe username as it was checked.
statusstringObrigatóriocurrentwhen it is the username the person already has.Um de"available""current""taken""reserved""invalid""too_short""too_long"availablebooleanObrigatóriomessagestringObrigatório