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, or be backed by a GitHub repository. This page explains the kinds, how to create and switch them, what signing in adds, how sync works, and how to share with a team.
Do you need an account?
No. Apiboo works signed out: collections, requests, environments, documents, boards, databases, terminals and the Vault are all stored on this computer. Signed out, every new workspace is a Local one.
You need an account for what goes through Apiboo's servers: syncing between devices and the web app, sharing, teams and chat. While you're signed out, Chat isn't on the rail and the title bar has no Teams, notifications or sync status.
Kinds of workspace
| Kind | Where it lives | Good for |
|---|---|---|
| Local | On this device only. | Work that never leaves your machine. Works offline and signed out. |
| Personal (cloud) | In your account, synced to your other devices. | Your own work across several computers. |
| Team | In a team's library, shared with its members. | Collections the whole team uses. |
| Git | Cloned from a GitHub repository. | Collections versioned next to your code. |
Switch workspaces
On API Client and History, the workspace switcher sits at the left of the title bar. Click it to open the list.
- 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.
| Action | Available for | Does |
|---|---|---|
| Share workspace | Signed in, not Local | Shares it with a team (see Share a workspace with a team). |
| Connect to GitHub / Push to GitHub | Not Git | Links it to a GitHub repository, then pushes changes. |
| Pull from GitHub | Linked to GitHub | Pulls changes from the repository. |
| Fork workspace | All | Copies it (see Fork a workspace). |
| Publish to cloud | Signed in, Local | Copies it into your account (see Publish a local workspace). |
| Edit workspace | All | Changes its name and description. |
| Delete workspace | All | Deletes it. |
You can also jump to a workspace with the command palette (Ctrl+K).
Create a workspace
- Open the workspace switcher and click Create new workspace.
- Under Start from, choose Blank workspace or Clone from GitHub.
- Enter the Workspace Name and, if you like, a Description.
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.
- Tick When this workspace is forked, copy variables and environments if forks should take them along.
- Click Create Workspace.
Signed out, there's no Storage choice: the workspace is saved as Local.
With Clone from GitHub, pick one of My repositories or Paste URL (a github.com URL or owner/repo), then click Clone repository.
Publish a local workspace
A Local workspace stays on this device until you publish it:
- Sign in.
- In the workspace switcher, open … on the Local workspace and choose Publish to cloud.
- 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:
| Destination | Result |
|---|---|
| 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
- Click Sign In at the right of the title bar.
- Click Continue in browser. Your browser opens Apiboo's sign-in page.
- Sign in or create an account there: with email and password, a passkey or GitHub, plus two-factor if you've set it up.
- Go back to Apiboo. The window updates by itself once you're signed in.
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
Once you're signed in, Apiboo syncs in the background. 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.
- New boards and documents go to the cloud while your plan has room there. Once it's full, new ones are kept on this device instead. Nothing is refused.
- 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 account, documents kept only on this computer appear under On this device in the Documents sidebar.
Paid plans keep everything in the cloud without limits. Your current usage is 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 a plan limit is near or reached, or when something couldn't sync. 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. Your cloud items come back the next time you sign in, and Local workspaces are kept.
Teams
Teams share workspaces, boards, documents and chat channels. Open Teams with the people icon in the title bar (signed in only).
- 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
- Open … on a personal cloud workspace and choose Share workspace.
- Pick the Team. You need the editor, admin or owner role in it.
- Optionally set a Name in team library.
- Tick Copy variables and environments when shared to take them along.
- 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.