DocuSign: List Workspaces
DocuSign esignature.esignatureWorkspaceGetWorkspaces: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_workspace_getworkspaces
Provider route: GET /restapi/v2.1/accounts/{accountId}/workspaces. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureWorkspaceGetWorkspaces"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.esignature.esignatureWorkspaceGetWorkspaces(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_docusign import DocuSignIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.esignature.esignature_workspace_get_workspaces(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand List Workspaces — response body |
Referenced models: List Workspaces — response body
Schemas
Section titled “Schemas”List Workspaces — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains a list of available workspaces. |
endPosition | string | Optional | The last index position in the result set. |
resultSetSize | string | Optional | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. |
startPosition | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
workspaces | array | Optional | A list of workspaces. |
workspaces[] | Model | Each item | Expand Get Workspace — response body |
Referenced models: Get Workspace — response body
Get Workspace — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Docusign workspace is a collaboration area for sharing files and data. |
billableAccountId | string | Optional | The ID of the account to bill. |
callerInformation | Model | Optional | Expand Get Workspace — response body — caller Information |
created | string | Optional | The UTC DateTime when the workspace user authorization was created. |
createdByInformation | Model | Optional | Expand Get Workspace — response body — caller Information Details about the user who created the workspace. |
lastModified | string | Optional | Utc date and time the comment was last updated (can only be done by creator.) |
lastModifiedByInformation | Model | Optional | Expand Get Workspace — response body — caller Information Details about the user who last modified the workspace. |
settings | Model | Optional | Expand Get Workspace — response body — settings Information about the settings for the workspace. |
status | string | Optional | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. |
workspaceBaseUrl | string | Optional | The relative URL for accessing the workspace. |
workspaceDescription | string | Optional | Text describing the purpose of the workspace. |
workspaceId | string | Optional | The ID of the workspace, always populated. |
workspaceName | string | Optional | The name of the workspace. |
workspaceUri | string | Optional | The relative URI for accessing the workspace. |
Referenced models: Get Workspace — response body — settings, Get Workspace — response body — caller Information
Get Workspace — response body — settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object provides information about the settings for the workspace. |
commentsAllowed | string | Optional | When **true,** commenting on the documents in the workspace is allowed. |
Get Workspace — response body — caller Information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object represents the workspace user. This property is only returned in response to user specific GET call. |
accountId | string | Optional | The account ID associated with the workspace user. |
accountName | string | Optional | The name of the account that the workspace user belongs to. |
activeSince | string | Optional | The UTC DateTime when the user joined the workspace. |
created | string | Optional | The UTC DateTime when the workspace user was created. |
createdById | string | Optional | The ID of the user who created this workspace user. |
email | string | Optional | The workspace user's email address. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
invitationEmailBlurb | string | Optional | The text of the workspace invitation email message sent to the user. |
invitationEmailSubject | string | Optional | The subject line of the workspace invitation email message sent to the user. |
lastModified | string | Optional | The UTC DateTime that the workspace user was last modified. |
lastModifiedById | string | Optional | The ID of the user who last modified the workspace user. |
status | string | Optional | Filters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired * ActivationSent * Active * Closed * Disabled |
type | string | Optional | Type of the user. Valid values: type_owner, type_participant. |
userId | string | Optional | The ID of the workspace user. |
userName | string | Optional | The name of workspace user. |
workspaceId | string | Optional | The ID of the workspace. |
workspaceUserBaseUrl | string | Optional | The URL for accessing the workspace user. |
workspaceUserId | string | Optional | The ID of the workspace user. |
workspaceUserUri | string | Optional | The URI for accessing the workspace user. |
Referenced models: Locks a template — response body — error Details
Locks a template — response body — error Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes errors that occur. It is only valid for responses and ignored in requests. |
errorCode | string | Optional | The code associated with the error condition. |
message | string | Optional | A brief message describing the error condition. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_workspace_getworkspaces. Catalog operation: esignature:Workspace_GetWorkspaces. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.