Workspace Items
List workspace folder contents
This method returns the contents of a workspace folder, which can include sub-folders and files.
Authorization
OAuth2 AuthorizationBearer <token>
OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
accountId*string
The external account number (int) or account ID GUID.
folderId*string
The ID of the folder.
workspaceId*string
The ID of the workspace.
Query Parameters
count?string
The maximum number of results to return.
Use start_position to specify the number of results to skip.
include_files?string
When true, the response includes file information (in addition to folder information). The default is false.
include_sub_folders?string
When true, the response includes information about the sub-folders of the current folder. The default is false.
include_thumbnails?string
When true, the response returns thumbnails. The default is false.
include_user_detail?string
When true, the response includes extended details about the user. The default is false.
start_position?string
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_id?string
If set, the response only includes results associated with the userId that you specify.
Response Body
application/json
application/json
curl -X GET "https://example.com/v2.1/accounts/string/workspaces/string/folders/string"{ "endPosition": "string", "folder": { "callerAuthorization": { "canDelete": "string", "canMove": "string", "canTransact": "string", "canView": "string", "created": "string", "createdById": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "modified": "string", "modifiedById": "string", "workspaceUserId": "string", "workspaceUserInformation": { "accountId": "string", "accountName": "string", "activeSince": "string", "created": "string", "createdById": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "invitationEmailBlurb": "string", "invitationEmailSubject": "string", "lastModified": "string", "lastModifiedById": "string", "status": "string", "type": "string", "userId": "string", "userName": "string", "workspaceId": "string", "workspaceUserBaseUrl": "string", "workspaceUserId": "string", "workspaceUserUri": "string" } }, "contentType": "string", "created": "string", "createdById": "string", "createdByInformation": { "accountId": "string", "accountName": "string", "activeSince": "string", "created": "string", "createdById": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "invitationEmailBlurb": "string", "invitationEmailSubject": "string", "lastModified": "string", "lastModifiedById": "string", "status": "string", "type": "string", "userId": "string", "userName": "string", "workspaceId": "string", "workspaceUserBaseUrl": "string", "workspaceUserId": "string", "workspaceUserUri": "string" }, "extension": "string", "fileSize": "string", "fileUri": "string", "id": "string", "isPublic": "string", "lastModified": "string", "lastModifiedById": "string", "lastModifiedByInformation": { "accountId": "string", "accountName": "string", "activeSince": "string", "created": "string", "createdById": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "invitationEmailBlurb": "string", "invitationEmailSubject": "string", "lastModified": "string", "lastModifiedById": "string", "status": "string", "type": "string", "userId": "string", "userName": "string", "workspaceId": "string", "workspaceUserBaseUrl": "string", "workspaceUserId": "string", "workspaceUserUri": "string" }, "name": "string", "pageCount": "string", "parentFolderId": "string", "parentFolderUri": "string", "sha256": "string", "thumbHeight": "string", "thumbnail": { "dpi": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "height": "string", "imageBytes": "string", "mimeType": "string", "pageId": "string", "sequence": "string", "width": "string" }, "thumbWidth": "string", "type": "string", "uri": "string", "userAuthorization": { "canDelete": "string", "canMove": "string", "canTransact": "string", "canView": "string", "created": "string", "createdById": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "modified": "string", "modifiedById": "string", "workspaceUserId": "string", "workspaceUserInformation": { "accountId": "string", "accountName": "string", "activeSince": "string", "created": "string", "createdById": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "invitationEmailBlurb": "string", "invitationEmailSubject": "string", "lastModified": "string", "lastModifiedById": "string", "status": "string", "type": "string", "userId": "string", "userName": "string", "workspaceId": "string", "workspaceUserBaseUrl": "string", "workspaceUserId": "string", "workspaceUserUri": "string" } } }, "items": [ { "callerAuthorization": { "canDelete": "string", "canMove": "string", "canTransact": "string", "canView": "string", "created": "string", "createdById": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "modified": "string", "modifiedById": "string", "workspaceUserId": "string", "workspaceUserInformation": { "accountId": "string", "accountName": "string", "activeSince": "string", "created": "string", "createdById": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "invitationEmailBlurb": "string", "invitationEmailSubject": "string", "lastModified": "string", "lastModifiedById": "string", "status": "string", "type": "string", "userId": "string", "userName": "string", "workspaceId": "string", "workspaceUserBaseUrl": "string", "workspaceUserId": "string", "workspaceUserUri": "string" } }, "contentType": "string", "created": "string", "createdById": "string", "createdByInformation": { "accountId": "string", "accountName": "string", "activeSince": "string", "created": "string", "createdById": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "invitationEmailBlurb": "string", "invitationEmailSubject": "string", "lastModified": "string", "lastModifiedById": "string", "status": "string", "type": "string", "userId": "string", "userName": "string", "workspaceId": "string", "workspaceUserBaseUrl": "string", "workspaceUserId": "string", "workspaceUserUri": "string" }, "extension": "string", "fileSize": "string", "fileUri": "string", "id": "string", "isPublic": "string", "lastModified": "string", "lastModifiedById": "string", "lastModifiedByInformation": { "accountId": "string", "accountName": "string", "activeSince": "string", "created": "string", "createdById": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "invitationEmailBlurb": "string", "invitationEmailSubject": "string", "lastModified": "string", "lastModifiedById": "string", "status": "string", "type": "string", "userId": "string", "userName": "string", "workspaceId": "string", "workspaceUserBaseUrl": "string", "workspaceUserId": "string", "workspaceUserUri": "string" }, "name": "string", "pageCount": "string", "parentFolderId": "string", "parentFolderUri": "string", "sha256": "string", "thumbHeight": "string", "thumbnail": { "dpi": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "height": "string", "imageBytes": "string", "mimeType": "string", "pageId": "string", "sequence": "string", "width": "string" }, "thumbWidth": "string", "type": "string", "uri": "string", "userAuthorization": { "canDelete": "string", "canMove": "string", "canTransact": "string", "canView": "string", "created": "string", "createdById": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "modified": "string", "modifiedById": "string", "workspaceUserId": "string", "workspaceUserInformation": { "accountId": "string", "accountName": "string", "activeSince": "string", "created": "string", "createdById": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "invitationEmailBlurb": "string", "invitationEmailSubject": "string", "lastModified": "string", "lastModifiedById": "string", "status": "string", "type": "string", "userId": "string", "userName": "string", "workspaceId": "string", "workspaceUserBaseUrl": "string", "workspaceUserId": "string", "workspaceUserUri": "string" } } } ], "parentFolders": [ { "callerAuthorization": { "canDelete": "string", "canMove": "string", "canTransact": "string", "canView": "string", "created": "string", "createdById": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "modified": "string", "modifiedById": "string", "workspaceUserId": "string", "workspaceUserInformation": { "accountId": "string", "accountName": "string", "activeSince": "string", "created": "string", "createdById": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "invitationEmailBlurb": "string", "invitationEmailSubject": "string", "lastModified": "string", "lastModifiedById": "string", "status": "string", "type": "string", "userId": "string", "userName": "string", "workspaceId": "string", "workspaceUserBaseUrl": "string", "workspaceUserId": "string", "workspaceUserUri": "string" } }, "contentType": "string", "created": "string", "createdById": "string", "createdByInformation": { "accountId": "string", "accountName": "string", "activeSince": "string", "created": "string", "createdById": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "invitationEmailBlurb": "string", "invitationEmailSubject": "string", "lastModified": "string", "lastModifiedById": "string", "status": "string", "type": "string", "userId": "string", "userName": "string", "workspaceId": "string", "workspaceUserBaseUrl": "string", "workspaceUserId": "string", "workspaceUserUri": "string" }, "extension": "string", "fileSize": "string", "fileUri": "string", "id": "string", "isPublic": "string", "lastModified": "string", "lastModifiedById": "string", "lastModifiedByInformation": { "accountId": "string", "accountName": "string", "activeSince": "string", "created": "string", "createdById": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "invitationEmailBlurb": "string", "invitationEmailSubject": "string", "lastModified": "string", "lastModifiedById": "string", "status": "string", "type": "string", "userId": "string", "userName": "string", "workspaceId": "string", "workspaceUserBaseUrl": "string", "workspaceUserId": "string", "workspaceUserUri": "string" }, "name": "string", "pageCount": "string", "parentFolderId": "string", "parentFolderUri": "string", "sha256": "string", "thumbHeight": "string", "thumbnail": { "dpi": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "height": "string", "imageBytes": "string", "mimeType": "string", "pageId": "string", "sequence": "string", "width": "string" }, "thumbWidth": "string", "type": "string", "uri": "string", "userAuthorization": { "canDelete": "string", "canMove": "string", "canTransact": "string", "canView": "string", "created": "string", "createdById": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "modified": "string", "modifiedById": "string", "workspaceUserId": "string", "workspaceUserInformation": { "accountId": "string", "accountName": "string", "activeSince": "string", "created": "string", "createdById": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "invitationEmailBlurb": "string", "invitationEmailSubject": "string", "lastModified": "string", "lastModifiedById": "string", "status": "string", "type": "string", "userId": "string", "userName": "string", "workspaceId": "string", "workspaceUserBaseUrl": "string", "workspaceUserId": "string", "workspaceUserUri": "string" } } } ], "resultSetSize": "string", "startPosition": "string", "totalSetSize": "string", "workspaceId": "string"}Updates configuration information for the eNote eOriginal integration PUT
Updates configuration information for the eNote eOriginal integration.
Deletes files or sub-folders from a workspace DELETE
This method deletes one or more files or sub-folders from a workspace folder or root. Note: To delete items from a workspace, the `status` of the workspace must be `active`.