Apiboo documentation

DocsGetting started

Workspaces, sync & teams

Workspaces and where they're stored, signing in, syncing between devices and working in a team.

Everything you build in the API tools lives in a workspace: its collections, environments and variables. A workspace can stay on this computer, live in your Apiboo account, belong to a team, and be kept in your own git repository (see Git). This page explains the kinds, how to create and switch them, how signing in works, how sync works, and how to share with a team.

Your Apiboo account

Apiboo needs an Apiboo account: the app shows Sign in to Apiboo until you sign in (see Sign in). The account doesn't decide where your work lives. Collections, requests, environments, documents, boards, databases, terminals and the Vault are stored on this computer; only what your plan syncs, and you choose to sync, goes to Apiboo's servers.

If you used Apiboo without an account before, what you made then is moved into your account the first time you sign in (see Data from before you had an account).

Kinds of workspace

KindWhere it livesGood for
LocalOn this device only.Work that never leaves your machine. Works offline.
Personal (cloud)In your account, synced to your other devices.Your own work across several computers.
TeamIn a team's library, shared with its members.Collections the whole team uses.
GitA folder on this device that is its own git repository.Collections versioned next to your code, committed with your own git tools.

Any Local, Personal or Team workspace can also sync to a GitHub, GitLab or other git repository. You connect it on the Git page; see Connect a workspace.

Switch workspaces

On API Client and History, the workspace switcher sits at the left of the title bar. Click it to open the list.

The workspace switcher open, with Local, Personal (cloud) and Team workspaces sections and the Bookshop workspace active
  • Search workspaces filters by name or kind. Use ↑, ↓ and Enter to pick one.
  • The list is grouped into Git, Local, Personal (cloud) and Team workspaces. Each row shows the workspace's kind under its name.
  • The active workspace has a dot. Click another to switch.
  • … (Workspace actions) on a row opens its menu.
ActionAvailable forDoes
Share workspaceNot LocalShares it with a team (see Share a workspace with a team).
Open Git pageNot GitOpens the Git page with this workspace selected, to connect, sync or pull it (see Git).
Fork workspaceAllCopies it (see Fork a workspace).
Publish to cloudLocal, on Pro or TeamCopies it into your account (see Publish a local workspace).
Edit workspaceAllChanges its name and description.
Delete workspaceAllDeletes it.

You can also jump to a workspace with the command palette (Ctrl+K).

Create a workspace

  1. Open the workspace switcher and click Create new workspace.
  2. Enter the Workspace Name and, if you like, a Description.
  3. Pick the Storage:

    • Personal (saved to cloud)
    • Local — this device only
    • Team workspace, offered when you're in a team. Pick the Team below it; the workspace belongs to the team from the start.
  4. Tick When this workspace is forked, copy variables and environments if forks should take them along.
  5. Click Create Workspace.

A Storage your plan doesn't include opens the upgrade window when you click Create Workspace.

To open a workspace from a repository instead, use Clone a repository on the Git page (see Clone a repository).

Publish a local workspace

A Local workspace stays on this device until you publish it. Publishing needs a plan with cloud workspaces (Pro or Team):

  1. In the workspace switcher, open … on the Local workspace and choose Publish to cloud.
  2. Confirm with Publish to cloud.

Its collections, requests, variables and environments are uploaded to your account as a private workspace.

Fork a workspace

A fork is an independent copy. Open … on a workspace, choose Fork workspace, and pick a Destination:

DestinationResult
Personal (cloud)A copy in your account.
Local (this device)A snapshot on this device that works offline. Choose Create new local workspace or Add to existing local workspace.

Tick Copy variables and environments to take them along, then click Fork.

Sign in

When you aren't signed in, Apiboo shows Sign in to Apiboo instead of the app. This happens the first time you start it and after you sign out.

  1. Click Continue in your browser. Your browser opens Apiboo's sign-in page. No account yet? Create a free account opens the sign-up page instead.
  2. Sign in or create your account there: with email and password, a passkey or GitHub, plus two-factor if you've set it up.
  3. Go back to Apiboo. While it waits it shows Waiting for your browser… and a Cancel button; the window updates by itself once you're signed in.

The first time you sign in on a computer where you used Apiboo without an account, what you made then is moved into your account.

The account button then shows your avatar, your first name and your plan. Its menu has Profile, Settings, Plan & billing, Switch account and Sign Out. Your name, picture, password, passkeys and two-factor settings are managed on your Apiboo account page, which Settings → Account links to.

Sync between devices

On a plan with cloud sync (Pro, Team or Enterprise), Apiboo syncs in the background. Free and Basic keep everything on this device. Changes go out about a second after you make them, and Apiboo checks for changes from your other devices every 30 seconds. Offline, your changes wait on this device and go out when the connection is back; nothing is dropped. While Apiboo can't reach its servers, the title bar shows Offline — reconnecting….

Boards and documents: cloud or this device

Each board and each document is either in the cloud (on your other devices and in the web app) or on this device only.

  • On Pro and Team, new boards and documents go to the cloud. On Free and Basic, which don't sync, they are kept on this device.
  • A subpage always stays with its parent page.
  • Move an item either way from its own menu: Move to cloud or Move to this device. For documents that's the right-click menu of a top-level personal document in the Documents sidebar; board tiles show a cloud or laptop badge and a move button.
  • On a Free or Basic account, documents kept only on this computer appear under On this device in the Documents sidebar.

Pro and Team keep as much in the cloud as you like. Your plan is shown in Settings → Billing (see See your plan and usage).

Sync status

A cloud icon appears in the title bar when sync needs your attention: when something couldn't sync, or when your plan doesn't sync a scope. Click it to see what's affected and what to do. See Sync.

Sign out and switch account

Switch account in the account menu lets you sign in as someone else. The account you leave keeps everything on this device.

Sign Out is different: it removes this account's data from this computer, apart from the Vault, and Apiboo shows Sign in to Apiboo again. Your cloud items come back the next time you sign in, and Local workspaces are kept.

When this account has data that exists only on this computer — boards and documents kept on this device, changes not synced yet, or workspace histories tracked only here (see Track on this device) — Sign Out asks first: Keep on this device and sign out leaves them in this account's own folder for the next time you sign in; Remove and sign out deletes them. Your Vault stays either way.

Teams

Teams share workspaces, boards, documents and chat channels. Creating a team needs the Team plan, which is billed per seat (see Account & plans). Open Teams with the people icon in the title bar.

The Teams page with the Bookshop team open: its members Maya and Leo Marchetti with their roles, and the team's workspaces
  • Create team asks for a Team Name, an optional description, and whether to Make team public (anyone can find and join).
  • Join with code joins a team with the invite code someone gave you.
  • Filter your teams with Owned by me, Admin and Member.

Invite people

Open a team and click Invite. Invite by Shareable link, Email invite or Code, and pick the role the new members get: viewer, editor or admin. A link can expire after 7, 30 or 90 days, or never, and can Require approval before someone gets in.

On a team's Members list, click a member's role to change it (if you're allowed to), and use the … menu on the row for Remove from team.

Share a workspace with a team

  1. Open … on a personal cloud workspace and choose Share workspace.
  2. Pick the Team. You need the editor, admin or owner role in it.
  3. Optionally set a Name in team library.
  4. Tick Copy variables and environments when shared to take them along.
  5. Click Share with team.

The workspace then appears for everyone in the team under Team workspaces in their workspace switcher.

Organizations

An organization sits above your teams: one place to administer them, with members, verified email domains and one invoice. The Teams | Organizations switch on the Teams page appears on the Enterprise plan, or once someone has added you to an organization.