Get webclip by id for a tenant
⚠️ iOS/iPadOS only.
Retrieves the full record for a specific webclip by its Esper UUID. Returns a single Webclip object with all fields including label, URL, target bundle ID and name, full-screen mode, removability, icon URL, and audit timestamps.
About Get Webclip
This endpoint fetches the complete detail record for a single webclip, identified by its Esper-assigned UUID. It is the direct lookup complement to GET /api/v2/webclips — use it when you already have the webclipId and need to confirm current configuration or retrieve specific field values before an update or deployment operation. The response is identical in structure to webclip records returned by the list endpoint.
Key Fields
webclipId (path) — Esper webclip UUID (required)
label — Home screen display name
url — URL the webclip opens
target_bundle_id / target_bundle_name — iOS app handling the URL
is_full_screen / is_removable — Behavioral flags
icon_url — URL for the webclip's home screen icon (nullable)
Common Use Cases
Confirming webclip configuration details before including it in a blueprint
Retrieving current url or target bundle values for audit or documentation purposes
Pre-flight check before a DELETE to confirm the correct webclip is targeted
Best Practices
Use this as a pre-flight check before DELETE operations to confirm the correct webclipId is targeted
If the webclipId is unknown, use GET /api/v2/webclips with exact_esper_name to look it up first
Path parameters
Response
Success
Example response
{
"content": {
"id": "09811f63-e2ca-4625-97c1-081145195d67",
"tenant_id": "7d5fd1bf-bdf9-490b-9e32-203756a61235",
"label": "Google",
"url": "https://www.google.com/",
"target_bundle_name": "Esper",
"target_bundle_id": "com.esper.io",
"is_removable": true
}
}