List workspace folder contents

GET

/v2.1/accounts/:accountId/workspaces/:workspaceId/folders/:folderId

GET

/restapi/v2.1/accounts/:accountId/workspaces/:workspaceId/folders/:folderId

curl https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/workspaces/WORKSPACE_ID/folders/FOLDER_ID \
     -H "Authorization: Bearer <apiKey>"

{
  "endPosition": "sample string 1",
  "folder": {
    "callerAuthorization": {
      "canDelete": "sample string 1",
      "canMove": "sample string 2",
      "canTransact": "sample string 3",
      "canView": "sample string 4",
      "created": "sample string 5",
      "createdById": "sample string 6",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      },
      "modified": "sample string 7",
      "modifiedById": "sample string 8",
      "workspaceUserId": "sample string 9",
      "workspaceUserInformation": {
        "accountId": "sample string 1",
        "accountName": "sample string 2",
        "activeSince": "sample string 3",
        "created": "sample string 4",
        "createdById": "sample string 5",
        "email": "sample string 6",
        "invitationEmailBlurb": "sample string 7",
        "invitationEmailSubject": "sample string 8",
        "lastModified": "sample string 9",
        "lastModifiedById": "sample string 10",
        "status": "sample string 11",
        "type": "sample string 12",
        "userId": "sample string 13",
        "userName": "sample string 14",
        "workspaceId": "sample string 15",
        "workspaceUserBaseUrl": "sample string 16",
        "workspaceUserId": "sample string 17",
        "workspaceUserUri": "sample string 18"
      }
    },
    "contentType": "sample string 1",
    "created": "sample string 2",
    "createdById": "sample string 3",
    "extension": "sample string 4",
    "fileSize": "sample string 5",
    "fileUri": "sample string 6",
    "id": "sample string 7",
    "isPublic": "sample string 8",
    "lastModified": "sample string 9",
    "lastModifiedById": "sample string 10",
    "name": "sample string 11",
    "pageCount": "sample string 12",
    "parentFolderId": "sample string 13",
    "parentFolderUri": "sample string 14",
    "sha256": "sample string 15",
    "thumbHeight": "sample string 16",
    "thumbnail": {
      "dpi": "sample string 1",
      "height": "sample string 2",
      "imageBytes": "sample string 3",
      "mimeType": "sample string 4",
      "pageId": "sample string 5",
      "sequence": "sample string 6",
      "width": "sample string 7"
    },
    "thumbWidth": "sample string 17",
    "type": "sample string 18",
    "uri": "sample string 19"
  },
  "items": [
    {}
  ],
  "parentFolders": [
    {}
  ],
  "resultSetSize": "sample string 2",
  "startPosition": "sample string 3",
  "totalSetSize": "sample string 4",
  "workspaceId": "sample string 5"
}

This method returns the contents of a workspace folder, which can include sub-folders and files.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

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

folderIdstringRequired

The ID of the folder.

workspaceIdstringRequired

The ID of the workspace.

Query parameters

countstringOptional

The maximum number of results to return.

Use start_position to specify the number of results to skip.

include_filesstringOptional

When true, the response includes file information (in addition to folder information). The default is false.

include_sub_foldersstringOptional

When true, the response includes information about the sub-folders of the current folder. The default is false.

include_thumbnailsstringOptional

When true, the response returns thumbnails. The default is false.

include_user_detailstringOptional

When true, the response includes extended details about the user. The default is false.

start_positionstringOptional

The zero-based index of the result from which to start returning results.

Use with count to limit the number of results.

The default value is 0.

workspace_user_idstringOptional

If set, the response only includes results associated with the userId that you specify.

Response

Successful response.

endPositionstringOptional

The last index position in the result set.

folderobjectOptional

This object represents an item in a workspace, which can be either a file or folder.

itemslist of objectsOptional

A list of workspace items.

parentFolderslist of objectsOptional

resultSetSizestringOptional

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.

startPositionstringOptional

The starting index position of the current result set.

totalSetSizestringOptional

The total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.

workspaceIdstringOptional

The id of the workspace, always populated.

Errors

400

Bad Request Error