This method returns a binary version of a file in a workspace.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

fileIdstring

The id of the file.

folderIdstring

The id of the folder.

workspaceIdstring

The id of the workspace.

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. The default is false.

pdf_versionstring

When set to true the file is returned in PDF format.

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

The code associated with the error condition.

messagestring

A brief message describing the error condition.

}} />