Box Developer Documentation
Log in
Latest version

Get watermark on file

get
https://api.box.com/2.0
/files/:file_id/watermark

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Retrieve the watermark for a file.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
12345

The 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.

get
Get watermark on file
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X GET "https://api.box.com/2.0/files/12345/watermark" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.fileWatermarks.getFileWatermark(file.id);
Python Gen
client.file_watermarks.get_file_watermark(file.id)
.NET Gen
await client.FileWatermarks.GetFileWatermarkAsync(fileId: file.Id);
Swift Gen (Beta)
try await client.fileWatermarks.getFileWatermark(fileId: file.id)
Java
BoxFile file = new BoxFile(api, id);
BoxWatermark watermark = file.getWatermark();
Python
watermark = client.file(file_id='12345').get_watermark()
print(f'Watermark created at {watermark.created_at} and modified at {watermark.modified_at}')
.NET
BoxWatermark watermark = await client.FilesManager.GetWatermarkAsync("11111");
Node
client.files.getWatermark('11111')
	.then(watermark => {
		/* watermark -> {
			watermark: 
			{ created_at: '2016-10-31T15:33:33-07:00',
				modified_at: '2016-10-31T15:33:33-07:00' } }
		*/
	});

Response Example

{
  "watermark": {
    "created_at": "2012-12-12T10:53:43-08:00",
    "modified_at": "2012-12-12T10:53:43-08:00"
  }
}