Workspaces API
Docusign Workspaces API
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Docusign Workspaces API
Endpoints 26
WorkspaceUploadRequest
- GETGets upload requests within a workspace
/v1/accounts/:accountId/workspaces/:workspaceId/upload-requestsThis operation retrieves a list of upload requests within a workspace. Each upload request includes details such as ID, name, description, status, owner… - POSTCreates a new upload request within a workspace
/v1/accounts/:accountId/workspaces/:workspaceId/upload-requestsThis operation creates a new upload request within a workspace. The upload request includes name, description, due date, and user assignments. Upload requests… - GETGets details for a specific upload request
/v1/accounts/:accountId/workspaces/:workspaceId/upload-requests/:uploadRequestIdThis operation retrieves details about a specific upload request within a workspace. The response includes comprehensive information about the upload request… - PUTUpdates a specific upload request
/v1/accounts/:accountId/workspaces/:workspaceId/upload-requests/:uploadRequestIdThis operation updates a specific upload request within a workspace. Only draft upload requests can be edited. The editable fields are name, description, due… - DELETEDeletes a specific upload request
/v1/accounts/:accountId/workspaces/:workspaceId/upload-requests/:uploadRequestIdThis operation deletes a specific upload request within a workspace. Upload requests cannot be deleted if they are complete or have associated documents. - POSTAdd a document to an upload request via file upload
/v1/accounts/:accountId/workspaces/:workspaceId/upload-requests/:uploadRequestId/documentsThis operation adds a document to a specific upload request within a workspace via file upload. The file is passed in the request body as multipart/form-data.… - POSTComplete an upload request
/v1/accounts/:accountId/workspaces/:workspaceId/upload-requests/:uploadRequestId/actions/completeThis operation completes a specific upload request within a workspace and is intended to be called by the user completing the upload request. Only upload…
Workspaces
- GETGets workspaces available to the calling user
/v1/accounts/:accountId/workspaces?count=0&start_position=0This operation retrieves a list of workspaces available to the calling user. It returns basic information about each workspace, including its unique… - POSTCreates a new workspace
/v1/accounts/:accountId/workspacesThis operation creates a new workspace. The calling user is automatically added as a member of the workspace with the role of Manage. Once created, the… - GETReturns details about the workspace
/v1/accounts/:accountId/workspaces/:workspaceIdThis operation retrieves details about a specific workspace. It returns the workspace's unique identifier (ID), name, and metadata such as when it was created… - PUTUpdates an existing workspace
/v1/accounts/:accountId/workspaces/:workspaceIdThis operation updates details about a specific workspace. It returns the workspace's unique identifier (ID), name, and metadata such as when it was created… - GETReturns the roles the caller can assign to workspace users
/v1/accounts/:accountId/workspaces/:workspaceId/assignable-roles?filter=string&start_position=0&count=0This operation returns roles that are assignable to users in the workspace based on the caller's role in the workspace. Roles available include Manage… - GETReturns the envelopes associated with the given workspace
/v1/accounts/:accountId/workspaces/:workspaceId/envelopesThis operation retrieves a list of all associated workspace envelopes. The status on each envelope can be used to track envelope progress. Statuses are… - POSTCreates an envelope with the given documents. Returns the ID of the created envelope
/v1/accounts/:accountId/workspaces/:workspaceId/envelopesThis operation creates an envelope associated with the workspace. Using the envelope_id from the response, the eSignature API may be utilized to modify the…
WorkspaceDocuments
- GETGet documents in the workspace accessible to the calling user
/v1/accounts/:accountId/workspaces/:workspaceId/documents?count=0&start_position=0&name_filter=stringThis operation retrieves the documents in the workspace that are accessible to the calling user. Documents may be added directly or automatically through… - POSTAdd a document to a workspace via file contents upload
/v1/accounts/:accountId/workspaces/:workspaceId/documentsThis operation adds a document to a workspace via file contents upload. The file is passed in the request body as a multipart/form-data file. The file name is… - GETGet information about the document
/v1/accounts/:accountId/workspaces/:workspaceId/documents/:documentIdThis operation retrieves information about the document. The response includes the document ID, name, and metadata. - DELETEDeletes a document in the workspace
/v1/accounts/:accountId/workspaces/:workspaceId/documents/:documentIdThis operation permanently deletes a document by ID. - GETGet the file contents of the document
/v1/accounts/:accountId/workspaces/:workspaceId/documents/:documentId/contentsThis operation retrieves the file contents of the document. The file is returned as a stream in the response body. The Content-Disposition response header…
WorkspaceUsers
- GETRetrieves the list of users in the given workspace
/v1/accounts/:accountId/workspaces/:workspaceId/users?count=0&start_position=0&filter=string&sort=first_name_ascThis operations retrieves the users in a workspace. Users sent envelopes or assigned tasks will automatically be added to the workspace with the Participate… - POSTAdds a user to the workspace by email address
/v1/accounts/:accountId/workspaces/:workspaceId/usersThis operation manually adds an internal or external user to a specific workspace by email address. Users within the account are considered "Internal" and may… - PUTUpdates the specified user's role
/v1/accounts/:accountId/workspaces/:workspaceId/users/:userIdThis operation updates the specified user's role in the workspace. Users within the account are considered "Internal" and may be assigned any role. Users… - POSTRevokes the specified user's access to the workspace
/v1/accounts/:accountId/workspaces/:workspaceId/users/:userId/actions/revoke-accessThis operation revokes the specified user's access to the workspace. The optional revocation_date may be set to schedule revocation in the future. If not… - POSTRestores the specified user's access to the workspace
/v1/accounts/:accountId/workspaces/:workspaceId/users/:userId/actions/restore-accessThis operation restores the specified user's access to the workspace. The user must have been previously revoked from the workspace. The access is immediately…
WorkspaceBrands
- GETReturns details about the brand set for a workspace
/v1/accounts/:accountId/workspaces/:workspaceId/brandThis operation retrieves details about a specific workspace. It returns the brand details such as its unique identifier (ID), name, and metadata such as brand… - PUTUpdates brand for an existing workspace
/v1/accounts/:accountId/workspaces/:workspaceId/brandThis operation updates brand for a specific workspace. It returns the brand details such as its unique identifier (ID), name, and metadata such as brand…
API details
- Base URL
https://api-d.docusign.com- Authentication
- OAuth 2.0 (authorization code flow) with 5 scopes
- Operations
- 26 operations on 16 pathsGET 11POST 9PUT 4DELETE 2
- Main resources
- WorkspaceUploadRequest 7Workspaces 7WorkspaceDocuments 5WorkspaceUsers 5WorkspaceBrands 2
- Response formats
application/jsonapplication/octet-stream- Description format
- OpenAPI 3.0.4, API version
v1 - Links
- OpenAPI document · Terms of service · Support
How to test the Workspaces API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Workspaces API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 5 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Gets upload requests within a workspace” (GET /v1/accounts/:accountId/workspaces/:workspaceId/upload-requests), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Workspaces API?
Docusign Workspaces API It is listed under Other and has 26 endpoints.
Who publishes the Workspaces API?
It is listed from DocuSign's public API description (an OpenAPI document), not published by DocuSign on Swastik Codes. Anyone who controls docusign.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Workspaces API?
Requests go to https://api-d.docusign.com. Endpoint paths are added to this base URL.
How do I authenticate with the Workspaces API?
With OAuth 2.0 (authorization code flow) with 5 scopes.
How many endpoints does the Workspaces API have?
26 operations on 16 paths (11 GET, 9 POST, 4 PUT, 2 DELETE). The largest groups are WorkspaceUploadRequest, Workspaces, WorkspaceDocuments, WorkspaceUsers.
Is forking the Workspaces API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.