Get webclips for a tenant
⚠️ Apple devices only.
Retrieves a paginated list of all webclips in the tenant library, with optional filtering by label or internal Esper name.
About List Webclips
Returns Webclip records for all webclips uploaded to the tenant — the same resource created by POST /api/v2/webclips. Each record includes the webclip's UUID, label, URL, target bundle details, full-screen and removability flags, icon URL, and audit timestamps. The exact_esper_name filter performs an exact-match lookup on the internal esper_name field, useful for finding a specific webclip by its Esper identifier without paginating through the full list. For a unified view of webclips alongside IPA-based apps, use GET /api/v2/apps with app_type=WEBCLIP.
Key Query Parameters
label — Filter by webclip display label (partial match)
exact_esper_name — Exact-match filter on the internal esper_name field
Common Use Cases
Looking up a specific webclip's UUID by its esper_name for use in blueprint or operation configuration
Auditing all webclips in the tenant library before a deployment or cleanup operation
Verifying webclip details (URL, target bundle, removability) before assigning to a blueprint
Best Practices
Use exact_esper_name when you know the internal name — it is more precise than label and avoids ambiguity with similarly labeled webclips
Paginate with limit and offset for tenants with large webclip libraries
Query parameters
Response
Success
Example response
{
"content": {
"results": [
{
"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
}
]
}
}