WorkspaceItems: listFolderItems

Retrieves workspace folder contents, which can include sub folders and files.

Request

HTTP request

GET /v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}

Parameters

Parameter name Value Description
Path parameters
accountId string

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

folderId string

The ID of the folder being accessed.

workspaceId string

Specifies the workspace ID GUID.

Optional query parameters
count string

The maximum number of results to be returned by this request.

include_files string

When set to true, file information is returned in the response along with folder information. The default is false.

include_sub_folders string

When set to true, information about the sub-folders of the current folder is returned. The default is false.

include_thumbnails string

When set to true, thumbnails are returned as part of the response. The default is false.

include_user_detail string

Set to true to return extended details about the user. The default is false.

start_position string

The position within the total result set from which to start returning values.

workspace_user_id string

If set, then the results are filtered to those associated with the specified userId.

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Workspaces::listWorkspaceFolderItems

Definitions Expand All | Collapse All

WorkspaceItems

callerAuthorization workspaceUserAuthorization
contentType string
created string

The UTC DateTime when the workspace item was created.

createdById string
createdByInformation workspaceUser
extension string
fileSize string
fileUri string
id string
isPublic string

If true, this supersedes need for bit mask permission with workspaceUserAuthorization

lastModified string

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

lastModifiedById string

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

lastModifiedByInformation workspaceUser
name string

A simple string description of the item, such as a file name or a folder name.

pageCount string
parentFolderId string

The ID of the parent folder. This is the GUID of the parent folder, or the special value 'root' for the root folder.

parentFolderUri string
type string

The type of the workspace item. Valid values are file, folder.

uri string

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

workspaceFolderContents

Provides properties that describe the contents of a workspace folder.

endPosition string

The last position in the result set.

folder WorkspaceItems

The query value can be a folder name or folder ID. The response will only return templates in the specified folder.

items
[WorkspaceItems]
parentFolders
[WorkspaceItems]
resultSetSize string

The number of results returned in this response.

startPosition string

Starting position of the current result set.

totalSetSize string

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.

workspaceId string

The id of the workspace, always populated.

workspaceUser

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

accountId string

The account ID associated with the envelope.

accountName string

The name of the account that the workspace user belongs to.

activeSince string
created string

The UTC DateTime when the workspace user was created.

createdById string
email string
errorDetails errorDetails
lastModified string

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

lastModifiedById string
status string

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

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled
type string

Type of the user. Valid values: type_owner, type_participant.

userId string

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 Admin on the account, this may be another user the Admin user is accessing.

userName string
workspaceId string

Specifies the workspace ID GUID.

workspaceUserBaseUrl string

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

workspaceUserId string

workspaceUserAuthorization

Provides properties that describe user authorization to a workspace.

canDelete string
canMove string
canTransact string
canView string
created string

The UTC DateTime when the workspace user authorization was created.

createdById string
errorDetails errorDetails
modified string
modifiedById string
workspaceUserId string
workspaceUserInformation workspaceUser

Examples

Generic JSON Response

Response

{
"workspaceId": "sample string 1",
"parentFolders": [
{
"id": "sample string 1",
"parentFolderId": "sample string 2",
"parentFolderUri": "sample string 3",
"name": "sample string 4",
"type": "sample string 5",
"uri": "sample string 6",
"extension": "sample string 7",
"contentType": "sample string 8",
"pageCount": "sample string 9",
"fileSize": "sample string 10",
"fileUri": "sample string 11",
"isPublic": "sample string 12",
"callerAuthorization": {
"workspaceUserId": "sample string 1",
"workspaceUserInformation": {
"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"
}
}
,
"canView": "sample string 2",
"canTransact": "sample string 3",
"canMove": "sample string 4",
"canDelete": "sample string 5",
"createdById": "sample string 6",
"created": "sample string 7",
"modifiedById": "sample string 8",
"modified": "sample string 9",
"errorDetails": {
"errorCode": "",
"message": ""
}
}
,
"created": "sample string 13",
"createdById": "sample string 14",
"createdByInformation": {},
"lastModified": "sample string 15",
"lastModifiedById": "sample string 16",
"lastModifiedByInformation": {}
}
]
,
"folder": {},
"items": [
{}
]
,
"resultSetSize": "sample string 2",
"startPosition": "sample string 3",
"endPosition": "sample string 4",
"totalSetSize": "sample string 5"
}

Generic XML Response

Response

<workspaceFolderContents 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<endPosition>sample string 4</endPosition>
<folder />
<items>
<workspaceItem />
</items>
<parentFolders>
<workspaceItem>
<callerAuthorization>
<canDelete>sample string 5</canDelete>
<canMove>sample string 4</canMove>
<canTransact>sample string 3</canTransact>
<canView>sample string 2</canView>
<created>sample string 7</created>
<createdById>sample string 6</createdById>
<errorDetails>
<errorCode></errorCode>
<message></message>
</errorDetails>
<modified>sample string 9</modified>
<modifiedById>sample string 8</modifiedById>
<workspaceUserId>sample string 1</workspaceUserId>
<workspaceUserInformation>
<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>
</workspaceUserInformation>
</callerAuthorization>
<contentType>sample string 8</contentType>
<created>sample string 13</created>
<createdById>sample string 14</createdById>
<createdByInformation />
<extension>sample string 7</extension>
<fileSize>sample string 10</fileSize>
<fileUri>sample string 11</fileUri>
<id>sample string 1</id>
<isPublic>sample string 12</isPublic>
<lastModified>sample string 15</lastModified>
<lastModifiedById>sample string 16</lastModifiedById>
<lastModifiedByInformation />
<name>sample string 4</name>
<pageCount>sample string 9</pageCount>
<parentFolderId>sample string 2</parentFolderId>
<parentFolderUri>sample string 3</parentFolderUri>
<type>sample string 5</type>
<uri>sample string 6</uri>
</workspaceItem>
</parentFolders>
<resultSetSize>sample string 2</resultSetSize>
<startPosition>sample string 3</startPosition>
<totalSetSize>sample string 5</totalSetSize>
<workspaceId>sample string 1</workspaceId>
</workspaceFolderContents>