Sample - Box Platform API
GET/folders/{folder_id}/watermark

Get a folder watermark

Retrieves the watermark associated with a folder. Use folder_id to identify the folder whose watermark information you want to inspect. The response includes the watermark creation and modification timestamps.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter
folder_idstringrequired
The unique identifier of the folder whose watermark to retrieve.

3 status codes
200Returns a watermark object containing the watermark's creation and modification timestamps.
watermarkobjectoptional
404Returned when the folder does not have a watermark applied.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
defaultReturned for an unexpected client error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

A 404 is returned when the folder does not have a watermark applied. folder_id must identify the folder whose watermark you want to retrieve.