Join BoxWorks 2024 to discover what's possible with content and AI!
Register now!Get watermark for folder
Retrieve the watermark for a folder.
Request
bearer [ACCESS_TOKEN]
application/json
Path Parameters
stringin pathrequired
12345The 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.
Request Example
cURL
curl -i -X GET "https://api.box.com/2.0/folders/4353455/watermark" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.folderWatermarks.getFolderWatermark(folder.id);Python Gen
client.folder_watermarks.get_folder_watermark(folder.id).NET Gen
await client.FolderWatermarks.GetFolderWatermarkAsync(folderId: folder.Id);Swift Gen (Beta)
try await client.folderWatermarks.getFolderWatermark(folderId: folder.id)Java
BoxFolder folder = new BoxFolder(api, id);
BoxWatermark watermark = folder.getWatermark();Python
watermark = client.folder(folder_id='11111').get_watermark()
print(f'Watermark created at {watermark.created_at} and modified at {watermark.modified_at}').NET
BoxWatermark watermark = await client.FoldersManager.GetWatermarkAsync("22222");Node
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"
}
}