REST APIAPI reference
Accounts
Cloud accounts: sign-in with Google, workspaces, members, roles and invitations (docs: Accounts, workspaces and roles)
36 operations, generated from apps/api/openapi.yaml (OpenAPI 3.2). Each page has the parameters, request body, responses and code samples, and a Send button to try the request against your cloud instance.
- GET
/v1/workspacesWorkspaces the caller can open, with their role - GET
/v1/auth/google/startStart the sign-in with GoogleStart the sign-in with Google (browser redirect) - GET
/v1/auth/google/callbackFinish the sign-in with GoogleFinish the sign-in with Google (browser redirect) - POST
/v1/auth/email/startSend a sign-in code to an email address - POST
/v1/auth/email/verifySign in with the emailed code - GET
/v1/auth/email/dev-codeThe last code sent to an addressThe last code sent to an address (AUTH_DEV_SIGNIN only, for tests) - POST
/v1/auth/passkey/startStart signing in with a passkey - POST
/v1/auth/passkey/finishSign in with the browser's passkey answer - GET
/v1/account/sign-in-methodsHow the signed-in person signs inHow the signed-in person signs in (Google, email addresses) - POST
/v1/account/sign-in-methods/email/startSend a code to an address the signed-in person wants to sign in with too - POST
/v1/account/sign-in-methods/email/verifyAdd the address as a sign-in method with its code - POST
/v1/account/sign-in-methods/email/change/current/startChanging the email sign-in address, step 1 - send a code to the current address - POST
/v1/account/sign-in-methods/email/change/current/verifyChanging the email sign-in address, step 1 - confirm the current address with its code - POST
/v1/account/sign-in-methods/email/change/new/startChanging the email sign-in address, step 2 - send a code to the new address - POST
/v1/account/sign-in-methods/email/change/new/verifyChanging the email sign-in address, step 2 - change it with the new address's code - POST
/v1/account/sign-in-methods/passkey/startStart adding a passkey - POST
/v1/account/sign-in-methods/passkey/finishAdd the passkey from the browser's answer - PATCH
/v1/account/sign-in-methods/passkey/{id}Rename a passkey - POST
/v1/account/sign-in-methods/googleStart adding a Google account as a sign-in method - DELETE
/v1/account/sign-in-methods/{provider}/{subject}Remove a sign-in methodRemove a sign-in method (409 for the last one) - POST
/v1/session/workspaceMove this browser session to another workspace the person belongs to - GET
/v1/account/notificationsThe signed-in person's notification choices - PUT
/v1/account/notificationsChange the signed-in person's notification choices - POST
/v1/notifications/unsubscribeTurn off one kind of email from its unsubscribe link - GET
/v1/accountThe signed-in person's accountThe signed-in person's account (account owners only) - PATCH
/v1/accountRename the accountRename the account (account owner) - POST
/v1/account/workspacesAdd a workspace to the accountAdd a workspace to the account (account owner; with billing it has no plan until a subscription starts, see GET /v1/billing trial) - GET
/v1/membersPeople in this workspace and their rolesPeople in this workspace and their roles (admin) - DELETE
/v1/members/{user_id}Remove a member, or leaveRemove a member, or leave (their sessions in this workspace end) - PATCH
/v1/members/{user_id}Change a member's roleChange a member's role (admins up to admin; owners any role) - GET
/v1/invitationsOpen invitationsOpen invitations (admins and owners) - POST
/v1/invitationsInvite someone by emailInvite someone by email (single-use link, 7 days) - GET
/v1/invitations/lookupWhat an invitation link is forWhat an invitation link is for (shown before signing in) - POST
/v1/invitations/acceptAccept an invitation as the signed-in personAccept an invitation as the signed-in person (idempotent; moves the session there) - POST
/v1/invitations/{id}/resendIssue a new link and a new expiryIssue a new link and a new expiry (the old link stops working) - DELETE
/v1/invitations/{id}Revoke an open invitation