Download a file

Returns downloadable content access for a file in the specified teamsite. Use this endpoint when a client needs either a direct redirect to the file stream (redirect=true) or a response body that contains a temporary download URL (redirect=false) for controlled retrieval workflows.

For Google Drive content (Google Docs, Sheets, and Slides), the file is converted on download. Use the optional targetFormat query parameter to choose the output format, such as PDF, DOCX, XLSX, or PPTX. The default is PDF. If the requested format is not supported for the file, the endpoint returns 400 and the error message lists the supported formats.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^(?:1|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as 1.

uuid
required
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Identifier of the library content item targeted by the operation. For file-specific endpoints, this must identify file content and not other content types.

Query Params
string
Defaults to PDF

Optional output format for Google Drive content (Google Docs, Sheets, and Slides), such as PDF, DOCX, XLSX, or PPTX. Defaults to PDF when omitted. The formats available depend on the file type; if the requested format is not supported, the endpoint returns 400 and lists the supported formats in the error message. Ignored for files that are not Google Drive content.

boolean
Defaults to false

Optional flag that controls response mode. When true, the endpoint responds with 302 and returns the temporary download link in the Location header. When false (default), the endpoint responds with 200 and returns a temporary download URL in the response body.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain