Skip to navigation
Docusign eSignature REST APIWorkspaces

Workspaces Resource

View as Markdown

This is the legacy eSignature Workspaces feature. To use the newest Workspaces product, please check our Workspaces API.

A workspace is a collaborative space for sharing documents and managing workflows. A workspace has a single owner who must be a Docusign user. The owner can invite others to the workspace as collaborators. Individuals who are not Docusign users must create a Docusign account to join a workspace as a collaborator.

You can create an envelope directly from a workspace.

Workspaces store the following information:

  • Files: Files uploaded to a workspace for storage or reuse.
  • Documents: A document is a component of a transaction, template, or workspace. When a file is added to a transaction, template, or workspace, it is copied as a document. Each document in a workspace has a single owner.
  • Templates: A set of documents that you can use to create a transaction or a workspace.
  • Transactions: A transaction is a series of workflow events related to one or more documents. These events route the documents to one or more individuals for the purposes of doing business. Each transaction has a single owner (the sender).

Note: Documents in a template are not individually listed as files.

Methods supported

MethodDescription
createPOST /restapi/v2.1/accounts/{accountId}/workspaces
Create a Workspace
deleteDEL /restapi/v2.1/accounts/{accountId}/workspaces/{workspaceId}
Delete Workspace
getGET /restapi/v2.1/accounts/{accountId}/workspaces/{workspaceId}
Get Workspace
listGET /restapi/v2.1/accounts/{accountId}/workspaces
List Workspaces
updatePUT /restapi/v2.1/accounts/{accountId}/workspaces/{workspaceId}
Update Workspace

Workspaces properties

PropertyTypeDescription
billableAccountIdstringThe ID of the account to bill.
callerInformationworkspaceUser
createdstringThe UTC DateTime when the workspace user authorization was created.
createdByInformationworkspaceUserDetails about the user who created the workspace.
lastModifiedstringUtc date and time the comment was last updated (can only be done by creator.)
lastModifiedByInformationworkspaceUserDetails about the user who last modified the workspace.
settingsworkspaceSettingsInformation about the settings for the workspace.
statusstringThe status of the workspace. Valid values are:
  • active
  • closed
workspaceBaseUrlstringThe relative URL for accessing the workspace.
workspaceDescriptionstringText describing the purpose of the workspace.
workspaceIdstringThe ID of the workspace, always populated.
workspaceNamestringThe name of the workspace.
workspaceUristringThe relative URI for accessing the workspace.