What is a Workspace?

Workspaces allow you to ensure the confidentiality of documents between your users, reflect the organization of your company (departments, subsidiaries, agencies...), or partition end customers if you are an ISV (Independent Software Vendor).

A Workspace can either be created on the application by users with theOwner role as detailed in this step-by-step guide or via the API.

📘

Sandbox environment

Currently, the application only supports the creation of Production Workspaces. To create Workspaces in the Sandbox environment, please use the API.

In the application, only users added to a Workspace can access the Signature Requests stored in that Workspace.

Associate a Signature Request to a Workspace

When you create a Signature Request, two options are available:

• You create a Signature Request without specifying a Workspace.
• You create a Signature Request in a specific Workspace.

Create a Signature Request without specifying the Workspace

{
    "name": "A new Signature Request created without specifying a Workspace",
    "delivery_mode": "email",
    "timezone": "Europe/Paris",
}

In this case, the Signature Request will be stored in the default workspace. Initially, this is the workspace automatically created at signup, unless it is modified afterward.

Create a Signature Request in a specific Workspace

{
    "name": "A new Signature Request created in a specific Workspace",
    "delivery_mode": "email",
    "timezone": "Europe/Paris",
    "workspace_id":"05fcb9e6-f153-4134-8967-eb39b6d02104"
}

In this case, the Signature Request will be stored in the Workspace with the id 05fcb9e6-f153-4134-8967-eb39b6d02104.

💡

Be careful when adding Signers to a Signature Request.

• As detailed in the Guide, Signers can be created from scratch, from a Contact, or from a User.
• If you add a Signer from a Contact or a User, they should already be in the same Workspace.

How can I retrieve theworkspace_id?

From the application

📘

Sandbox environment

Only Production Workspaces are displayed in the application. To retrieve the workspace_id for Workspaces in the Sandbox environment, please use the API.

1. Log into the application using the owner account.
2. Go to the Workspaces page : https://yousign.app/auth/settings/workspaces
3. Locate the desired Workspace, and from the Actions menu, click on “Copy workspace ID”

From the API

You can list all workspaces using GET /workspaces

Manage users within Workspaces

You can manage Users within your Workspaces through the Workspaces endpoints. This includes adding or removing Users as needed, provided they belong to your organization.

Adding Users

To add a User to a Workspace, ensure the User is already part of your organization, and use the PUT workspaces/{workspaceId}/users/{userId} endpoint (see API reference).

Once the User is successfully added, they will have access to the Workspace's resources.

Removing Users

To remove a User from a Workspace, use the DELETE workspaces/{workspaceId}/users/{userId} endpoint (see API reference).

Removing a User from a Workspace has a few conditions to keep in mind:

• The User who is the Owner of the organization cannot be removed from any Workspace
• A User must belong to at least one Workspace.

There features help manage your team and ensure that only the appropriate Users have access to specific Workspaces.