---
title: "Get all viewers"
method: GET
path: "/v1/viewers"
tags: ["Viewer information & management"]
---

# Get all viewers

`GET /v1/viewers`

## Request

- Base URL: `https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/protect/integration`
- URL: `https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/protect/integration/v1/viewers`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ubiquiti/apis/unifi-protect-api/docs/v1/viewers/get.ts> (a function with typed inputs; its response is checked against the schema)

Get detailed information about all viewers

## Response `200`

Success response

- Viewer[]
  - `id` string, required: The primary key of viewer
  - `modelKey` 'viewer', required: The model key of the viewer
  - `state` 'CONNECTED' | 'CONNECTING' | 'DISCONNECTED', required: Connection state of the device.
  - `name` string, required: The name of the device.
  - `mac` string, required: The primary MAC address of the device.
  - `liveview` string, required: The primary key of liveview
  - `streamLimit` number, required: Count of maximum supported parallel live streams.

## Other responses

- `default`: Error response

---

[API](https://skmtc.dev/ubiquiti/apis/unifi-protect-api.md) - [All operations](https://skmtc.dev/ubiquiti/apis/unifi-protect-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ubiquiti/apis/unifi-protect-api/revisions/e341e1381db1?raw)