---
title: "List all live streams"
method: GET
path: "/live-streams"
tags: ["Live Streams"]
---

# List all live streams

`GET /live-streams`

Get the list of livestreams on the workspace.

## Query parameters

- `streamKey` string
- `name` string
- `sortBy` 'name' | 'createdAt' | 'updatedAt'
- `sortOrder` 'asc' | 'desc'
- `currentPage` integer
- `pageSize` integer

## Response `200`

Success

- LiveStreamListResponse
  - `data` LiveStream[], required
    - `liveStreamId` string, required — The unique identifier for the live stream. Live stream IDs begin with "li."
    - `name` string — The name of your live stream.
    - `streamKey` string — The unique, private stream key that you use to begin streaming.
    - `public` boolean — Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view. Learn more about the Private Video feature [here](https://docs.api.video/delivery/video-privacy-access-management).
    - `assets` LiveStreamAssets
      - `hls` string, uri — The http live streaming (HLS) link for your live video stream.
      - `iframe` string — The embed code for the iframe containing your live video stream.
      - `player` string, uri — A link to the video player that is playing your live stream.
      - `thumbnail` string, uri — A link to the thumbnail for your video.
    - `playerId` string — The unique identifier for the player.
    - `broadcasting` boolean — Whether or not you are broadcasting the live video you recorded for others to see. True means you are broadcasting to viewers, false means you are not.
    - `restreams` RestreamsResponseObject[], required — Returns the list of restream destinations.
      - `name` string — Returns the name of a restream destination.
      - `serverUrl` string — Returns the server URL of a restream destination.
      - `streamKey` string — Returns the unique key of the live stream that is set up for restreaming.
    - `createdAt` string, date-time — When the player was created, presented in ATOM UTC format.
    - `updatedAt` string, date-time — When the player was last updated, presented in ATOM UTC format.
  - `pagination` Pagination, required
    - `itemsTotal` integer — Total number of items that exist.
    - `pagesTotal` integer — Number of items listed in the current page.
    - `pageSize` integer — Maximum number of item per page.
    - `currentPage` integer — The current page index.
    - `currentPageItems` integer — The number of items on the current page.
    - `links` PaginationLink[], required
      - `rel` string
      - `uri` string, uri

## Other responses

- `429` — Too Many Requests

## Changes

> 50 revisions in range; 1 not diffed.

- **2024-04-16** `ec2b79bfdc8d` — 1 info
  - added the non-success response with the status `429`
- **2023-12-20** `6c10f5429263` — 1 breaking, 3 info
  - the `query` request parameter `sortBy` was restricted to a list of enum values
  - added the new enum value `createdAt` to the `query` request parameter `sortBy`
  - added the new enum value `name` to the `query` request parameter `sortBy`
  - added the new enum value `updatedAt` to the `query` request parameter `sortBy`
- **2023-09-11** `b32ea09011ae` — 1 warning
  - removed the optional property `data/items/record` from the response with the `200` status
- **2023-06-28** `ec139d07f5cd` — 1 info
  - added the required property `data/items/restreams` to the response with the `200` status
- **2022-04-28** `f9532dd3578c` — 2 info
  - the endpoint scheme security `apiKey` was added to the API
  - the endpoint scheme security `bearerAuth` was removed from the API

[Full history](https://skmtc.dev/apivideo/apis/api-video/changes/live-streams/get.md)

---

[API](https://skmtc.dev/apivideo/apis/api-video.md) · [All operations](https://skmtc.dev/apivideo/apis/api-video/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/apivideo/api-video/revisions/45ec26f342b6/schema)