---
title: "List lockbox devices"
method: GET
path: "/lkbx"
tags: ["LKBX"]
---

# List lockbox devices

`GET /lkbx`

## Request

- Base URL: `https://dashboard.researchanddesire.com/api/v1`
- URL: `https://dashboard.researchanddesire.com/api/v1/lkbx`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `/oauth/authorize`
    - Token URL: `/oauth/token` scopes: `lkbx:read`

Returns all Chastity Lockbox devices registered to your account, ordered by most recently visited.

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

List of lockbox devices

- LkbxDeviceListResponse
  - `ok` true, required
  - `data` object, required
    - `data` LkbxDevice[], required
      - `id` integer: Device ID
      - `bubbleId` string: Unique public identifier
      - `macAddress` string: Device MAC address
      - `ownerId` integer: Owner user ID
      - `locked` boolean: True while this device has an active lock session whose lockState is "locked". False during a break (including break_pending and break_ending, when the box is open), before the box has closed, and when there is no active session. Derived from the active session; for the full state use GET /lkbx/session/current.
      - `hueShift` integer: LED color hue shift
      - `lastVisited` string, date-time: Last connection time
      - `lastLogAt` string, date-time: Last log entry time
    - `pagination` Pagination, required
      - `limit` integer, required: Number of records returned
      - `offset` integer, required: Number of records skipped

## Other responses

- `401`: Authentication required or token invalid
- `500`: Internal server error

## Changes

- **2026-09-22** `2411203b3c10`: 2 info
  - the endpoint scheme security `bearerAuth` was added to the API
  - the endpoint scheme security `oauth2` was added to the API

[Operation history](https://skmtc.dev/researchanddesire/apis/research-and-desire-api/changes/lkbx/get.md)

---

[API](https://skmtc.dev/researchanddesire/apis/research-and-desire-api.md) - [All operations](https://skmtc.dev/researchanddesire/apis/research-and-desire-api/llms.txt) - [OpenAPI document](https://skmtc.dev/researchanddesire/apis/research-and-desire-api/revisions/682fc4d7f6d5?raw)