A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.
Latest version
Get watermark on file
API version 2024.0
Retrieve the watermark for a file.
Request
bearer [ACCESS_TOKEN]
application/json
Path Parameters
stringin pathrequired
12345The unique identifier that represents a file.
The ID for any file can be determined
by visiting a file in the web application
and copying the ID from the URL. For example,
for the URL https://*.app.box.com/files/123
the file_id is 123.
Response
application/jsonWatermark
Returns an object containing information about the watermark associated for to this file.
application/jsonClient error
Returns an error if the file does not have a watermark applied.
application/jsonClient error
An unexpected client error.
Request Example
cURL
curl -i -X GET "https://api.box.com/2.0/files/12345/watermark" \
-H "authorization: Bearer <ACCESS_TOKEN>"Node/TypeScript v10
await client.fileWatermarks.getFileWatermark(file.id);Python v10
client.file_watermarks.get_file_watermark(file.id).NET v10
await client.FileWatermarks.GetFileWatermarkAsync(fileId: file.Id);Swift v10
try await client.fileWatermarks.getFileWatermark(fileId: file.id)Java v10
client.getFileWatermarks().getFileWatermark(file.getId()).NET v6
await client.FileWatermarks.GetFileWatermarkAsync(fileId: file.Id);Node v4
await client.fileWatermarks.getFileWatermark(file.id);Response Example
{
"watermark": {
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00"
}
}