Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Content File

GET/api/v2/notepad/files/{fileRid}/content
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Download file content.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:notepad-export.

Path parameters

fileRid
string

The unique identifier for a File

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Response body

body
string

Examples

Request

Copied!
1 2 3 curl \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/notepad/files/ri.notepad.main.file.cf32c039-353c-4555-9704-eacfdfaa2c1c/content?preview=true"

Error responses

Error Name
ContentFilePermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionCould not content the File.
ParametersfileRid