# Displays: Session & Sharing **Page:** api/displays/session-sharing [Download Raw Markdown](./api/displays/session-sharing.md) --- {/* AUTO-GENERATED — Do not edit manually. Regenerate with: npm run docs:api:generate */} ## Session & Sharing Control how multiple users interact with a display session through URL parameters on the HTML5 Display client endpoint. Use these parameters to enable session sharing, allow takeover of existing sessions, enforce read-only viewing, and manage browser tab power consumption. They are useful for monitoring dashboards, kiosk deployments, collaborative scenarios, and energy-efficient client behavior. ### `GET /api/v1/display/` Access the HTML5 Display client interface with session and sharing configuration. #### Parameters | Name | In | Type | Required | Description | |------|-----|------|----------|-------------| | `sharing` | query | boolean | No | Allow session sharing. Default: `false` | | `steal` | query | boolean | No | Steal existing sessions. Default: `true` | | `readonly` | query | boolean | No | Enable read-only/view-only mode. Blocks all keyboard and mouse input from the client. Perfect for dashboards, monitoring, or demo scenarios. Works independently or combines with server readonly setting. Default: `false` | | `suspend_inactive_tab` | query | boolean | No | Suspend client updates when browser tab is inactive. Enables power saving by calling `client.suspend()` on tab hide and `client.resume()` on tab show. Recommended to keep enabled for better performance. Default: `true` | Combine `readonly=true` with `sharing=true` to let multiple users view a display simultaneously while preventing any of them from sending keyboard or mouse input — ideal for monitoring dashboards and live demonstrations. #### Response ```json { "description": "HTML5 Display client interface loaded successfully", "content": { "text/html": { "schema": { "type": "string" }, "example": "\n\nHoody Display Client\n\n \n\n\n" } } } ``` #### SDK Usage ```javascript const result = await client.display.accessClient({ sharing: true, steal: true, readonly: true, suspend_inactive_tab: true }); ``` ```bash curl "https://domain.com/api/v1/display/?displayId=10&sharing=true&steal=true&readonly=true&suspend_inactive_tab=true" ```