Docusign Workspaces Rest Swagger
DocuSign Workspaces REST Swagger is an API connector for DocuSign Workspaces, which provides shared spaces for organizing and collaborating on agreement documents.
- Base URL:
https://api-d.docusign.com - Auth: OAuth 2.0 (user-delegated) — attach an InTouch
oauthcredential. Mint one withitcli.py /oauth <provider>(device-code) or/google-auth(Google); the server auto-refreshes the access token before each run, so the connector never handles or stores tokens.
Operations
getworkspacebrand— GET /v1/accounts/{accountId}/workspaces/{workspaceId}/brand — Returns details about the brand set for a workspacegetworkspacedocuments— GET /v1/accounts/{accountId}/workspaces/{workspaceId}/documents — Get documents in the workspace accessible to the calling usergetworkspacedocument— GET /v1/accounts/{accountId}/workspaces/{workspaceId}/documents/{documentId} — Get information about the documentgetworkspacedocumentcontents— GET /v1/accounts/{accountId}/workspaces/{workspaceId}/documents/{documentId}/contents — Get the file contents of the documentgetworkspaceuploadrequests— GET /v1/accounts/{accountId}/workspaces/{workspaceId}/upload-requests — Gets upload requests within a workspacegetworkspaceuploadrequest— GET /v1/accounts/{accountId}/workspaces/{workspaceId}/upload-requests/{uploadRequestId} — Gets details for a specific upload request
Inputs
- a linked
oauthcredential (no key inputs) — the server injects a freshAuthorization: Bearerfrom it operation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: getworkspacebrand
# (attach an 'oauth' credential to the task — no inline secrets)
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
operation |
string | yes | — | One of: getworkspacebrand, getworkspacedocuments, getworkspacedocument, getworkspacedocumentcontents, getworkspaceuploadrequests, getworkspaceuploadrequest |
accountId |
string | no | — | Path parameter accountId (required by some operations). |
documentId |
string | no | — | Path parameter documentId (required by some operations). |
uploadRequestId |
string | no | — | Path parameter uploadRequestId (required by some operations). |
workspaceId |
string | no | — | Path parameter workspaceId (required by some operations). |
query |
string | no | — | Optional query params as a JSON object string, e.g. {"limit": 10}. |