API template library

Simulate the DocuSign Workspaces API

A WireMock simulation of DocuSign's REST API — covering shared workspaces with their members and roles, documents, envelopes, upload requests and branding.

Vendor
DocuSign
Functionality
Workspaces, members, documents, upload requests
Spec version
1.0.0
Endpoints
27
Stubs
113
Protocol
REST
Validation
AI-validated Before publication, an AI agent exercised these endpoints against the real DocuSign API through WireMock's recording proxy, and the recorded traffic was used to verify each stub's request and response shapes.

Live sandbox · no signup, no API key

DocuSign Workspaces API

A running WireMock Cloud instance of this template, callable right now from a terminal, a script, or an AI agent.

Base URL
https://g47wyr.wiremockapi.cloud

POST Create a workspace with an upload request

curl -s -X POST 'https://g47wyr.wiremockapi.cloud/v1/accounts/2f5a7c9e-1b3d-4f6a-8c2e-4a6b8d0f2a41/workspaces' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Juniper Lane closing","upload_requests":[{"name":"Proof of insurance","status":"in_progress","assignments":[{"email":"buyer@example.com","first_name":"Rae","last_name":"Kim","upload_request_responsibility_type_id":"assignee"}]}]}'

GET List workspaces, newest first

curl -s -X GET 'https://g47wyr.wiremockapi.cloud/v1/accounts/2f5a7c9e-1b3d-4f6a-8c2e-4a6b8d0f2a41/workspaces' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Method Path Summary
GET /v1/accounts/{accountId}/workspaces Gets workspaces available to the calling user
POST /v1/accounts/{accountId}/workspaces Creates a new workspace
GET /v1/accounts/{accountId}/workspaces/{workspaceId} Returns details about the workspace
PUT /v1/accounts/{accountId}/workspaces/{workspaceId} Updates an existing workspace
GET /v1/accounts/{accountId}/workspaces/{workspaceId}/assignable-roles Returns the roles the caller can assign to workspace users
GET /v1/accounts/{accountId}/workspaces/{workspaceId}/brand Returns details about the brand set for a workspace
PUT /v1/accounts/{accountId}/workspaces/{workspaceId}/brand Updates brand for an existing workspace
GET /v1/accounts/{accountId}/workspaces/{workspaceId}/documents Get documents in the workspace accessible to the calling user
POST /v1/accounts/{accountId}/workspaces/{workspaceId}/documents Add a document to a workspace via file contents upload
DELETE /v1/accounts/{accountId}/workspaces/{workspaceId}/documents/{documentId} Deletes a document in the workspace
GET /v1/accounts/{accountId}/workspaces/{workspaceId}/documents/{documentId} Get information about the document
GET /v1/accounts/{accountId}/workspaces/{workspaceId}/documents/{documentId}/contents Get the file contents of the document
GET /v1/accounts/{accountId}/workspaces/{workspaceId}/envelopes Returns the envelopes associated with the given workspace
POST /v1/accounts/{accountId}/workspaces/{workspaceId}/envelopes Creates an envelope with the given documents. Returns the ID of the created envelope
POST /v1/accounts/{accountId}/workspaces/{workspaceId}/envelopes/actions/import Import envelopes with specified envelopeIds into a Workspace
GET /v1/accounts/{accountId}/workspaces/{workspaceId}/upload-requests Gets upload requests within a workspace
POST /v1/accounts/{accountId}/workspaces/{workspaceId}/upload-requests Creates a new upload request within a workspace
DELETE /v1/accounts/{accountId}/workspaces/{workspaceId}/upload-requests/{uploadRequestId} Deletes a specific upload request
GET /v1/accounts/{accountId}/workspaces/{workspaceId}/upload-requests/{uploadRequestId} Gets details for a specific upload request
PUT /v1/accounts/{accountId}/workspaces/{workspaceId}/upload-requests/{uploadRequestId} Updates a specific upload request
POST /v1/accounts/{accountId}/workspaces/{workspaceId}/upload-requests/{uploadRequestId}/actions/complete Complete an upload request
POST /v1/accounts/{accountId}/workspaces/{workspaceId}/upload-requests/{uploadRequestId}/documents Add a document to an upload request via file upload
GET /v1/accounts/{accountId}/workspaces/{workspaceId}/users Retrieves the list of users in the given workspace
POST /v1/accounts/{accountId}/workspaces/{workspaceId}/users Adds a user to the workspace by email address
PUT /v1/accounts/{accountId}/workspaces/{workspaceId}/users/{userId} Updates the specified user's role
POST /v1/accounts/{accountId}/workspaces/{workspaceId}/users/{userId}/actions/restore-access Restores the specified user's access to the workspace
POST /v1/accounts/{accountId}/workspaces/{workspaceId}/users/{userId}/actions/revoke-access Revokes the specified user's access to the workspace

Unauthenticated WireMock Cloud demo sandbox for DocuSign — not an official DocuSign sandbox, and it returns simulated example data only.

What's inside the Workspaces template

Workspaces gives a deal team and its outside parties one shared place for documents, envelopes and requests for files. Accounts start with no workspaces, and a single create call can do several jobs at once: import envelope ids, open upload requests, apply a brand, and batch-send. An upload request created in_progress with a due date already passed reads back as overdue, and its assignee joins the workspace as a Participate member beside the caller, Avery Lucky, who holds Manage. A workspace without a brand shows the account default, Lucky Shrub, with its button and header colors and logo URLs.

  • Workspaces — create with envelopes, upload requests, branding and batch send in one call; list, read and update
  • Members and roles — Manage and Participate roles, invitations, scheduled or immediate revocation, and restore
  • Documents — multipart uploads, filtered listing, raw content download and delete
  • Envelopes — create from workspace documents or import existing envelope ids
  • Upload requests — draft, in progress, overdue and complete states, with documents added by the assignee
  • Branding — the workspace's brand, falling back to the account's default sending brand

DocuSign Workspaces mock API FAQ

Only people inside the account, meaning addresses on luckyshrub.com. Anyone else can join as Participate, and asking for Manage answers 400 ROLE_NOT_ASSIGNABLE. Role ids come from the assignable-roles call. Adding an address that is already a member, even in different case, answers USER_ALREADY_EXISTS.

A complete request, or one that already has documents, can't be deleted (UPLOAD_REQUEST_NOT_DELETABLE). Only drafts can be edited, and completing or adding a document works only while a request is in progress, overdue included. Each refusal is a 400 naming the rule.

Revoking without a date removes the member from the user list straight away, and restore brings them back. Calling restore for someone whose access isn't revoked answers 400 USER_NOT_REVOKED. A revocation_date in the future is stored and takes effect on that date.

They're ids with a status. Creating one from workspace documents returns a new envelope_id in Created, an unknown document id answers DOCUMENT_NOT_FOUND, and batch_send at creation marks imported envelopes Sent; nothing goes out by email. Each account id has its own data, the token isn't checked, and requests without one answer 401.

Vendor names identify APIs represented by WireMock template sources. This page does not imply vendor endorsement, certification, partnership, or official integration status.