Skip to main content
GET
Get Watermark

Authorizations

Authorization
string
header
required

Aspect API key (sk_...) in Authorization header. 'Bearer ' optional.

Path Parameters

watermark_id
string<uuid>
required

Response

Successful Response

API response schema for a watermark

id
string<uuid>
required

Watermark ID

workspace_id
string<uuid>
required

Workspace ID

name
string
required

Display name

config
WatermarkConfig · object
required

Visual configuration

version
integer
required

Version number, incremented on each update

created_by_user_id
string<uuid> | null
required

User who created this watermark. Null when that account has been deleted

created
string<date-time>
required

Creation timestamp

updated
string<date-time>
required

Last update timestamp

active_share_count
integer
default:0

Number of shares currently using this watermark