--- title: "openemail.workspaces" description: "Every method in this namespace: its signature, its parameters, what it returns and an example." url: "https://openemail.uk/docs/sdk/reference/workspaces" area: "SDK" category: "Reference" --- # openemail.workspaces Every method in this namespace: its signature, its parameters, what it returns and an example. ## Methods The workspaces the person behind the key or the app can open: list them, create one, choose the one the app opens, and delete the workspace the key or the app belongs to. An API key acts for the workspace owner, and an app for the person who connected it. ### `workspaces.list()` List your workspaces ```ts list(options?: RequestScope): Promise ``` Resolves every workspace the person behind the client can open, the ones they own first, as the workspace switcher of the app lists them. It is about the person, not the workspace the key belongs to. An API key answers for the workspace owner, and an app for the person who connected it. `activeWorkspaceId` is the workspace the app opens for them, `primaryWorkspaceId` the first one they made, which can never be deleted, and `personalWorkspaceId` their personal space, which holds their free address and is not in `data`. Scopes: `account:read`. **Parameters** - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `WorkspaceListResource` with `data`, an array of `WorkspaceResource`, and `activeWorkspaceId`, `primaryWorkspaceId` and `personalWorkspaceId`. **Example** ```ts const { data, activeWorkspaceId } = await openemail.workspaces.list() for (const workspace of data) console.log(workspace.name, workspace.id === activeWorkspaceId ? '(open in the app)' : '') ``` **Notes** - The key or the app still acts for its own workspace in every other call. Also available in: API [`GET /workspaces`](https://openemail.uk/docs/api/reference/workspaces#get-workspaces); CLI [`openemail workspaces list`](https://openemail.uk/docs/cli/reference/workspaces#workspaces-list). ### `workspaces.create()` Create a workspace ```ts create(body: WorkspaceCreate, options?: RequestScope): Promise ``` Makes a new workspace owned by the person, on the Free plan, and makes it the workspace the app opens for them, as creating one in the app does. The key or the app making the call keeps acting for its own workspace. An account can own one workspace on the Free plan. While it owns one, the call is refused with 403 `workspace_allowance_reached` and the message names that workspace: upgrade it first. Scopes: `account:write`. **Parameters** - `body.name` (`string`, required): Up to 64 characters. Leading and trailing spaces are trimmed. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `CreatedWorkspaceResource` with `id`, `name`, `slug` and `active: true`. **Example** ```ts const workspace = await openemail.workspaces.create({ name: 'Acme Support' }) console.log(workspace.id, workspace.slug) ``` **Notes** - Not retried automatically. The same name sent twice within ten seconds returns the workspace the first call made, so a retry right after a lost response is safe. Also available in: API [`POST /workspaces`](https://openemail.uk/docs/api/reference/workspaces#post-workspaces); CLI [`openemail workspaces create`](https://openemail.uk/docs/cli/reference/workspaces#workspaces-create). ### `workspaces.getActive()` Read the workspace the app opens ```ts getActive(options?: RequestScope): Promise ``` Resolves the workspace the app opens for the person when they sign in, or the one it falls back to when they never chose one. It is not the workspace the key or the app acts on, which never changes. Scopes: `account:read`. **Parameters** - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `ActiveWorkspaceResource` with `id`, `name`, `slug`, `email`, `kind`, `isOwner` and `createdAt`. **Example** ```ts const opened = await openemail.workspaces.getActive() console.log(opened.name, opened.kind) ``` **Notes** - `kind` is `personal` when the app opens the personal space. Also available in: API [`GET /workspaces/active`](https://openemail.uk/docs/api/reference/workspaces#get-workspaces-active); CLI [`openemail workspaces get-active`](https://openemail.uk/docs/cli/reference/workspaces#workspaces-get-active). ### `workspaces.setActive()` Choose the workspace the app opens ```ts setActive(workspaceId: string, options?: RequestScope): Promise ``` Switches the workspace the app opens for the person, as the workspace switcher does, to any workspace they can open. It changes nothing for the key or the app making the call, which keeps acting for its own workspace. Scopes: `account:write`. **Parameters** - `workspaceId` (`string`, required): A workspace id from `list`. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `ActiveWorkspaceResource` for the workspace the app opens now. **Example** ```ts await openemail.workspaces.setActive('10417196-e324-4283-af98-66ec62167c47') ``` **Notes** - A workspace the person cannot open is a 404 `resource_not_found`. - Retried automatically on network failure, since choosing the same workspace twice changes nothing. Also available in: API [`PUT /workspaces/active`](https://openemail.uk/docs/api/reference/workspaces#put-workspaces-active); CLI [`openemail workspaces set-active`](https://openemail.uk/docs/cli/reference/workspaces#workspaces-set-active). ### `workspaces.delete()` Delete the workspace ```ts delete(id: string, options: WorkspaceDeleteOptions): Promise ``` Deletes the workspace the key or the app belongs to, with its domains, addresses, mail and members, and cancels its plan. It cannot be undone. `options.confirm` has to be the name of the workspace, as `list` shows it, the same way the app asks the person to type it. Only the owner may do it. An access token acting for a member is refused with 403 `owner_only`, and a key or an app limited to particular addresses or domains with 422 `capability_unsupported`. Any other workspace id is a 404, the first workspace an account made is refused with 409 `first_workspace`, and one with a domain being moved in or out with 409 `domain_moving`. Scopes: `account:write`. **Parameters** - `id` (`string`, required): The id of the workspace the key or the app belongs to, which `me.get` reports as `workspaceId`. - `options.confirm` (`string`, required): The name of the workspace. Letter case and the spaces around it do not matter. Sent as a query parameter. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DeletedWorkspaceResource` with `id`, `deleted: true` and `activeWorkspaceId`, the workspace the app opens from now on. **Example** ```ts const key = await openemail.me.get() await openemail.workspaces.delete(key.workspaceId, { confirm: 'Acme Support' }) ``` **Notes** - An OAuth access token needs a verification code for this call, and is refused with 403 `step_up_required` until the app has verified one in the last 60 minutes. `isStepUpRequired` on the error says so. An API key is never asked for a code. - The key or the app loses its workspace with it, so every later call with it is refused. - Not retried automatically. A retry after a lost response is a 404, since the workspace is already gone. Also available in: API [`DELETE /workspaces/{id}`](https://openemail.uk/docs/api/reference/workspaces#delete-workspaces-id); CLI [`openemail workspaces delete`](https://openemail.uk/docs/cli/reference/workspaces#workspaces-delete).