Retrieves a workspace file (the binary).

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

fileIdstring

Specifies the room file ID GUID.

folderIdstring

The ID of the folder being accessed.

workspaceIdstring

Specifies the workspace ID GUID.

Optional Query Parameters
is_downloadstring

When set to true, the Content-Disposition header is set in the response. The value of the header provides the filename of the file. Default is false.

pdf_versionstring

When set to true the file returned as a PDF.

Responses

CodeDescriptionReference
200

Successful response.

400

Error encountered.

errorDetails

SDK Method

Workspaces::getWorkspaceFile

Definitions

errorDetails

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

errorCodestring

An error code associated with the error.

messagestring

A short error message.

}} />