Get file

Retrieve the metadata for the given file, including the record it is attached to and its view/download URLs. The file contents are not returned; use /api/cms/documents/{id}/content for that. The required permission depends on the file's link type: person files require Read Files; business files require Limited Write Contributions or Full Write Accounting; batch files require Limited Read Contributions; bank_reconciliation files require Full Read Accounting; group files require being an administrator or member of the group; other link types follow the permissions of the record the file is attached to.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the file

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

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