Skip to main content

Workspaces

A workspace is a separate data space inside your organization. Customers, charges, collection rules, templates, channels, integrations, webhooks, imports and exports belong to a workspace — and only show up for people who can access it.

Organization (your account)
└── Workspace          ← data space (e.g. "Principal", "Retail")
    └── Company        ← legal entity, with a tax ID (the "headquarters")
        └── Branch     ← business unit inside the company

Every organization starts with the Principal workspace. Add others when you need portfolios that never mix: different operations, a partner's customers, a sandbox for testing collection rules. To split units of the same portfolio, use companies and branches.

What lives in the workspace and what lives in the organization​

In the workspaceIn the organization (shared by all)
Customers, charges, agreements, disputes, tasksMembers and roles (permissions)
Collection rules, templates, classifications, channelsAccount details and brand
Companies and branches, email layoutsUsage (sum of every workspace)
Integrations, webhooks, imports, exportsAudit of members and workspaces
Debtor portal (settings and subdomain)

Switching workspaces​

The header shows the active workspace next to the organization name. Click it to switch — the screens then show the data of the chosen workspace. People with access to more than one workspace pick which one to enter right after signing in.

Creating, renaming and deleting​

On the Workspaces screen (side menu, Account group):

  • New workspace creates the space with a headquarters company; whoever creates it becomes its owner. Requires the workspaces.create permission.
  • Rename and Delete belong to the workspace owners (and to the organization administrators).
  • Delete hides all the workspace data and turns off its integrations and webhooks. The dialog shows how many people, charges, integrations and webhooks are affected, and asks for the workspace name to confirm. The last workspace of the organization cannot be deleted.

Who can access each workspace​

On the Members screen, the workspaces button of each row lists the organization's workspaces. Check the ones the member can open:

  • Unchecking pauses the access (history is kept) and ends the member's session right away.
  • A workspace is never left without an owner: removing the last one is refused.
  • When inviting someone, choose the invitation's workspaces; without a choice, the workspace you are in applies.
  • Organization administrators access every workspace, including the ones created later.

What each person can do inside the workspace is still defined by roles and permissions.

In the API and the MCP​

  • API: send the workspace id in the X-Workspace-Id header. It is optional while the organization has a single workspace; with two or more, a call without the header answers 400 WORKSPACE_REQUIRED. List the workspaces with GET /v1/workspaces. The ID is also shown on the Workspaces screen.
  • MCP: every tool that reaches data takes a workspace_id argument; the dunning_workspaces_list tool lists the connected person's workspaces.
  • Webhooks: every delivery body carries workspace_id, and an endpoint only receives the events of its own workspace.