Box Developer Documentation
Log in
Latest version

Get watermark for folder

get
https://api.box.com/2.0
/folders/:folder_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 folder.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
12345

The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123.

The root folder of a Box account is always represented by the ID 0.

Response

application/jsonWatermark

Returns an object containing information about the watermark associated for to this folder.

application/jsonClient error

Returns an error if the folder does not have a watermark applied.

application/jsonClient error

An unexpected client error.

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

Request Example

Learn more about Box SDK versioning strategy.


cURL
curl -i -X GET "https://api.box.com/2.0/folders/4353455/watermark" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.folderWatermarks.getFolderWatermark(folder.id);
Python v10
client.folder_watermarks.get_folder_watermark(folder.id)
.NET v10
await client.FolderWatermarks.GetFolderWatermarkAsync(folderId: folder.Id);
Swift v10
try await client.folderWatermarks.getFolderWatermark(folderId: folder.id)
Java v10
client.getFolderWatermarks().getFolderWatermark(folder.getId())
Java v4
BoxFolder folder = new BoxFolder(api, id);
BoxWatermark watermark = folder.getWatermark();
Python v3
watermark = client.folder(folder_id='11111').get_watermark()
print(f'Watermark created at {watermark.created_at} and modified at {watermark.modified_at}')
.NET v5
BoxWatermark watermark = await client.FoldersManager.GetWatermarkAsync("22222");
Node v3
client.folders.getWatermark('22222')
	.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"
  }
}