Retrieves a workspace file (the binary).

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
accountId string

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

fileId string

Specifies the room file ID GUID.

folderId string

The ID of the folder being accessed.

workspaceId string

Specifies the workspace ID GUID.

Optional query parameters
is_download string

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_version string

When set to true the file returned as a PDF.

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Workspaces::getWorkspaceFile

Definitions Expand All | Collapse All

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.