Get one overlay
One overlay, plus the widget types currently on its layout. Requires overlays:manage.
/overlays/{overlayId}AuthorizationBearer token (tp_live_... or tpat_...) · headerrequiredA TipPage API key (tp_live_..., created in Dashboard → Settings → Developer) or an OAuth 2.0 access token (tpat_..., see the OAuth guide). Both carry the same scopes and are accepted on every endpoint.
overlayIdstringrequiredThe overlay's id (o_ + 8 hex chars).
The overlay.
overlayobjectShow propertiesHide properties
idstringnamestringresolutionobjectThe overlay's fixed canvas resolution in pixels.
Show propertiesHide properties
widthintegerheightintegercreated_atstring<date-time> | nullupdated_atstring<date-time> | nullwidgetsstring[]Widget types on the layout.
celebrationsobject[]Placed Event celebration widget instances - their ids target POST .../celebrate at one specific widget.
Show propertiesHide properties
objectidstringnamestring | nullMissing or invalid credential (missing_api_key / invalid_api_key, or invalid_token for an expired/revoked OAuth access token).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
The key lacks the required scope (missing_scope).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
required_scopestringNo such resource.
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
Rate limit exceeded - check the RateLimit-* headers.
errorstring