Gets information about the Workspaces that have been created.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

Responses

CodeDescriptionReference
200

Successful response.

workspaceList
400

Error encountered.

errorDetails

SDK Method

Workspaces::listWorkspaces

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

workspaceList

Provides properties that describe the workspaces avaialble.

endPositionstring

The last position in the result set.

resultSetSizestring

The number of results returned in this response.

startPositionstring

Starting position of the current result set.

totalSetSizestring

The total number of items in the search's result set. It will always be greater than or equal to the value of the resultSetSize field.

workspaces[Workspaces]

A list of workspaces.

workspaceSettings

commentsAllowedstring

workspaceUser

A workspaceUser representing the user. This property is only returned in response to user specific GET call.

accountIdstring

The account ID associated with the envelope.

accountNamestring

The name of the account associated with the current workspace user.

activeSincestring

createdstring

The UTC DateTime when the workspace user was created.

createdByIdstring

emailstring

Filters returned user records by the specified email address.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

invitationEmailBlurbstring

invitationEmailSubjectstring

lastModifiedstring

Utc date and time the comment was last updated (can only be done by creator.)

lastModifiedByIdstring

statusstring

Filters the results by user status. You can specify a comma-separated list of the following statuses:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled

typestring

Type of user:

  • type_owner
  • type_participant

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Administrator on the account, this can be another user the Admin user is accessing. Note: For Envelopes:listStatusChanges (GET /v2.1/accounts/{accountId}/envelopes), the user_id query parameter is not implemented and should not be used.

userNamestring

The name of the user.

workspaceIdstring

Specifies the workspace ID GUID.

workspaceUserBaseUrlstring

The relative URI that may be used to access a workspace user.

workspaceUserIdstring

workspaceUserUristring

Workspaces

billableAccountIdstring

callerInformationworkspaceUser

createdstring

The UTC DateTime when the workspace user authorization was created.

createdByInformationworkspaceUser

lastModifiedstring

Utc date and time the comment was last updated (can only be done by creator.)

lastModifiedByInformationworkspaceUser

settingsworkspaceSettings

statusstring

The status of the item.

workspaceBaseUrlstring

The relative URL that may be used to access the workspace.

workspaceDescriptionstring

Text describing the purpose of the workspace.

workspaceIdstring

The id of the workspace, always populated.

workspaceNamestring

The name of the workspace.

workspaceUristring

The relative URI that may be used to access the workspace.

Examples

Generic JSON Response

Response
{
  "resultSetSize": "sample string 1",
  "startPosition": "sample string 2",
  "endPosition": "sample string 3",
  "totalSetSize": "sample string 4",
  "workspaces": [
    {
      "workspaceId": "sample string 1",
      "workspaceName": "sample string 2",
      "workspaceDescription": "sample string 3",
      "status": "sample string 4",
      "workspaceUri": "sample string 5",
      "workspaceBaseUrl": "sample string 6",
      "billableAccountId": "sample string 7",
      "created": "sample string 8",
      "createdByInformation": {
        "workspaceUserId": "sample string 1",
        "status": "sample string 2",
        "type": "sample string 3",
        "workspaceId": "sample string 4",
        "accountId": "sample string 5",
        "userId": "sample string 6",
        "accountName": "sample string 7",
        "userName": "sample string 8",
        "email": "sample string 9",
        "workspaceUserBaseUrl": "sample string 10",
        "created": "sample string 11",
        "createdById": "sample string 12",
        "lastModified": "sample string 13",
        "lastModifiedById": "sample string 14",
        "activeSince": "sample string 15",
        "errorDetails": {
          "errorCode": "sample string 1",
          "message": "sample string 2"
        }
      },
      "lastModified": "sample string 9",
      "lastModifiedByInformation": {}
    }
  ]
}
Generic XML Response

Response
<workspaceList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <endPosition>sample string 3</endPosition>
  <resultSetSize>sample string 1</resultSetSize>
  <startPosition>sample string 2</startPosition>
  <totalSetSize>sample string 4</totalSetSize>
  <workspaces>
    <workspace>
      <billableAccountId>sample string 7</billableAccountId>
      <created>sample string 8</created>
      <createdByInformation>
        <accountId>sample string 5</accountId>
        <accountName>sample string 7</accountName>
        <activeSince>sample string 15</activeSince>
        <created>sample string 11</created>
        <createdById>sample string 12</createdById>
        <email>sample string 9</email>
        <errorDetails>
          <errorCode>sample string 1</errorCode>
          <message>sample string 2</message>
        </errorDetails>
        <lastModified>sample string 13</lastModified>
        <lastModifiedById>sample string 14</lastModifiedById>
        <status>sample string 2</status>
        <type>sample string 3</type>
        <userId>sample string 6</userId>
        <userName>sample string 8</userName>
        <workspaceId>sample string 4</workspaceId>
        <workspaceUserBaseUrl>sample string 10</workspaceUserBaseUrl>
        <workspaceUserId>sample string 1</workspaceUserId>
      </createdByInformation>
      <lastModified>sample string 9</lastModified>
      <lastModifiedByInformation />
      <status>sample string 4</status>
      <workspaceBaseUrl>sample string 6</workspaceBaseUrl>
      <workspaceDescription>sample string 3</workspaceDescription>
      <workspaceId>sample string 1</workspaceId>
      <workspaceName>sample string 2</workspaceName>
      <workspaceUri>sample string 5</workspaceUri>
    </workspace>
  </workspaces>
</workspaceList> 
}} />