---
title: "Get light details"
method: GET
path: "/v1/lights/{id}"
tags: ["Light information & management"]
---

# Get light details

`GET /v1/lights/{id}`

## 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/lights/{id}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ubiquiti/apis/unifi-protect-api/docs/v1/lights/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Get detailed information about a specific light

## Path parameters

- `id` string, required: The primary key of light

## Response `200`

Success response

- Light
  - `id` string, required: The primary key of light
  - `modelKey` 'light', required: The model key of the light
  - `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.
  - `lightModeSettings` LightModeSettings, required: Settings for when and how your light gets activated
    - `mode` union: When will floodlight turn on.
      - 'always'
      - 'motion'
      - 'off'
    - `enableAt` union: At what time is the lighting mode relevant and acted upon (this has no effect when mode is off).
      - 'fulltime'
      - 'dark'
  - `lightDeviceSettings` LightDeviceSettings, required: Hardware settings for light device.
    - `isIndicatorEnabled` boolean: Turn on/off floodlight status LED indicator.
    - `pirDuration` number: How long the light stays on after a motion event in milliseconds.
    - `pirSensitivity` number: How sensitive is the PIR to motion (0-100)%.
    - `ledLevel` number: Brightness level of the main LED (1-6).
  - `isDark` boolean, required: Whether the light is currently sensing that it's in a dark scene.
  - `isLightOn` boolean, required: Whether the light has its main LED currently enabled.
  - `isLightForceEnabled` boolean, required: Whether the light has its main LED currently force-enabled.
  - `lastMotion` number, nullable, required: Unix timestamp of the last time the PIR motion-detection was triggered.
  - `isPirMotionDetected` boolean, required: Whether the light PIR is currently detecting motion
  - `camera` string, required: The primary key of camera

## 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)
