DocuSign Momentum 2018DocuSign Momentum 2018

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 NameValueDescription
Path Parameters
accountIdstring

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

folderIdstring

The ID of the folder being accessed.

workspaceIdstring

Specifies the workspace ID GUID.

Optional Query Parameters
countstring

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

include_filesstring

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

include_sub_foldersstring

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

include_thumbnailsstring

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

include_user_detailstring

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

start_positionstring

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

workspace_user_idstring

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

Responses

CodeDescriptionReference
200

Successful response.

workspaceFolderContents
400

Error encountered.

errorDetails

SDK Method

Workspaces::listWorkspaceFolderItems

Definitions

errorDetails
workspaceFolderContents
workspaceUser
workspaceUserAuthorization
WorkspaceItems

Examples

Generic JSON Response
Generic XML Response