Skip to main content
A workspace is an isolated area inside an organization, such as a department, a team, or a client. Every document lives in exactly one workspace, and so do the templates, contacts, and settings it uses. Every API request works in one workspace. An OAuth token is bound to the workspace chosen when it was granted. An API key can act in several workspaces: a request acts in the key’s default workspace, or in the one named in the Sajn-Workspace header.

What belongs to a workspace

Each workspace has its own set of the following:
  • Documents, folders, and document categories
  • Templates and forms
  • Contacts and companies
  • Custom fields
  • Webhook endpoints
  • API keys
  • Members, workspace roles, and document settings, such as the default expiration and allowed signing methods
A document in one workspace can’t use a contact, template, or custom field from another workspace.

Workspace properties

The following properties identify a workspace:

Workspaces in the API

A request with an API key acts in the key’s default workspace, unless the Sajn-Workspace header names another workspace that the key can act in. To check which workspace a request acts in, call GET /me:
To list the workspaces the key can act in, call GET /workspaces. The workspace that the request acts in has isCurrent set to true. To work in another of them, send its id in the Sajn-Workspace header. For more information, see Choose a workspace.

Members and roles

Each member has one workspace role per workspace. The role decides what the member can do in the workspace. An API key has its own permissions, which you set when you create the key. Every workspace has the built-in roles Läsare, Medarbetare, Säljare, Godkännare, and Avdelningsansvarig, and you can add custom roles. You can manage members and roles through the API: A member’s id is the user ID, and the /members/{userId} endpoints take it. A member has the following shape:
POST /members with email and roleId adds someone who is already a member of the organization. For any other email address, it returns 404, unless the address is on a domain that your organization manages through SSO. To invite someone new, call POST /member-invites with the same body. The response is the invitation, with its status and expiresAt.

Workspace limits

Your plan decides how many workspaces the organization can have. To read the quota and current usage, call GET /limits and read quota.workspaces and usage.workspaces. An unlimited quota is returned as null.

Next steps

Documents

The document lifecycle, from draft to sealed PDF.

Authentication

Create an API key for a workspace.