---
title: "Get all overlays"
method: GET
path: "/streaming/streams/{stream_id}/overlays"
tags: ["Overlays"]
---

# Get all overlays

`GET /streaming/streams/{stream_id}/overlays`

Returns a list of HTML overlay widgets which are attached to a stream

## Path parameters

- `stream_id` integer, required

## Response `200`

Successful

- OverlayId[]
  - `url` string, required — Valid http/https URL to an HTML page/widget
  - `width` integer — Width of the widget
  - `height` integer — Height of the widget
  - `x` integer — Coordinate of left upper corner
  - `y` integer — Coordinate of left upper corner
  - `stretch` boolean — Switch of auto scaling the widget. Must not be used as "true" simultaneously with the coordinate installation method (w, h, x, y).
  - `id` integer, required — ID of the overlay
  - `stream_id` integer, required — ID of a stream to which it is attached
  - `created_at` string, required — Datetime of creation in ISO 8601
  - `updated_at` string, required — Datetime of last update in ISO 8601

---

[API](https://skmtc.dev/g-core/apis/gcore-openapi.md) · [All operations](https://skmtc.dev/g-core/apis/gcore-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/g-core/gcore-openapi/revisions/09e652815095/schema)