Get workspace file

GET

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

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

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.

fileIdstringRequired

The ID of the file.

folderIdstringRequired

The ID of the folder.

workspaceIdstringRequired

The ID of the workspace.

Query parameters

is_downloadstringOptional

When 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_versionstringOptional

When true the file is returned in PDF format.

Response

Successful response.

Errors

400

Bad Request Error