Skip to content

List state changes, newest first​

GET
/api/v1/history

Requires an API key with the read or write role.

Authorizations​

bearerAuth

An API key issued by the Pixelbar board. A read key can fetch history; a write key can also change the state.

Type
HTTP (bearer)

Parameters​

Query Parameters

from

Only entries at or after this time.

Type
string
Format
"date-time"
to

Only entries at or before this time.

Type
string
Format
"date-time"
device

Only entries from this legacy device shortname.

Type
string
limit

Page size. Values above 200 are clamped to 200.

Type
integer
Minimum
1
Default
50
Maximum
200
continuationToken

Opaque token from a previous page's continuationToken.

Type
string

Responses​

A page of history.

application/json
JSON
{
  
"items": [
  
  
{
  
  
  
"state": "open",
  
  
  
"user": "your-name",
  
  
  
"method": "button",
  
  
  
"deviceShortname": "frontdoor",
  
  
  
"source": "api",
  
  
  
"changedAt": "2026-10-18T19:04:11.000Z"
  
  
}
  
],
  
"continuationToken": "1!52!RGF0ZQ--"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Rendered with vitepress-openapi · themed after pixelbar.nl/pixel