{"api":"esign_rest","category":"reference"}

Workspaces Category

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.

WorkspaceItems

This object contains information about a file or folder in a workspace.

MethodDescription
listFolderItems
GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}

List workspace folder contents

deleteFolderItems
DELETE /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}

Deletes files or sub-folders from a workspace.

createFIle
POST /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files

Creates a workspace file.

getFile
GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}

Gets a workspace file

updateFile
PUT /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}

Update workspace file or folder metadata

listFilePages
GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages

List File Pages

Workspaces

A DocuSign workspace is a collaboration area for sharing files and data.

MethodDescription
list
GET /v2.1/accounts/{accountId}/workspaces

List Workspaces

create
POST /v2.1/accounts/{accountId}/workspaces

Create a Workspace

get
GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}

Get Workspace

update
PUT /v2.1/accounts/{accountId}/workspaces/{workspaceId}

Update Workspace

delete
DELETE /v2.1/accounts/{accountId}/workspaces/{workspaceId}

Delete Workspace

}} />