Ваш аккаунт
Каждая операция этой группы: что она принимает, что возвращает и какими ошибками может ответить.
Операции
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.
Возвращает
The notification settings.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
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.
Параметры пути
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Каталог ошибок
Также доступно в
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.
Параметры пути
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Каталог ошибок
Также доступно в
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.
Тело запроса
Тип содержимогоimage/png, image/jpeg, image/webp, image/gif
Возвращает
The photo, with its new url.
Ошибки
- 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.
Ошибки, которые может вернуть любая операция400401403404500Каталог ошибок
Также доступно в
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.
Возвращает
Removed, with url null.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
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.
Возвращает
The username.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
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.
Тело запроса
usernamestringОбязательно- До 60 символов
Возвращает
The username, now chosen.
Ошибки
- 409
username_locked: the username was chosen before and never changes.username_taken: another account has it.
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
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.
Параметры запроса
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Каталог ошибок
Также доступно в
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.
Возвращает
The connected apps.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
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.
Параметры пути
clientIdstringОбязательноThe app's
clientIdfromGET /account/connected-apps.
Возвращает
Removed.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
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.
Возвращает
The invitations.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
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.
Параметры пути
invitationIdstringОбязательноThe invitation id from
GET /account/invitations.
Тело запроса
activateboolean
Возвращает
Joined.
Ошибки
- 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Каталог ошибок
Также доступно в
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.
Параметры пути
invitationIdstringОбязательноThe invitation id from
GET /account/invitations.
Возвращает
Declined.
Ошибки
Ошибки, которые может вернуть любая операция400401403404422500Каталог ошибок
Также доступно в
Объекты
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Обязательноclifor a sign-in of the command line tool,appfor every other app.Одно из"app""cli"cliDevicestring- Может быть null
currentbooleanОбязательноWhether it is the app making this call.
registeredByAccountbooleanredirectUrisstring[]connectedAtstring- Может быть nullФормат
date-time accessUntilstringWhen its last token runs out.
Может быть nullФорматdate-timetokenCountintegerОбязательно- Не меньше 0
statusstringОбязательно- Одно из
"active""expired""needs-approval""access-lost" usablePermissionsintegerHow many of the permissions it was given the person still holds.
Может быть nullelevatedUntilstringUntil when it may make changes that ask for a verification code without one.
Может быть nullФорматdate-timegrantobjectWhat the person gave it, or null for an app that has to ask again.
Может быть nullworkspaceIdstringОбязательно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-timeupdatedAtstringОбязательно- Формат
date-time
ConnectedAppListobject
objectstring- Одно из
"list" dataConnectedApp[]
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.
Не меньше 0expiresAtstringОбязательно- Формат
date-time createdAtstringОбязательно- Формат
date-time
ReceivedInvitationListobject
objectstring- Одно из
"list"
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Обязательноcurrentwhen it is the username the person already has.Одно из"available""current""taken""reserved""invalid""too_short""too_long"availablebooleanОбязательноmessagestringОбязательно