Skip to main content
GET
Outline a deck

Authorizations

Authorization
string
header
required

An API key from Settings › API, sent as Authorization: Bearer ptr_…. Shown once when made; only a hash is stored.

Path Parameters

id
string
required

The deck's id

Minimum string length: 1

Response

OK

title
string
required
steps
object[]
required
ready
boolean
required

Every poll passes the readiness check, so a room can start

problems
object[]
required

What stops it, by step; empty when ready

revision
string
required

The deck's revision after this write; send it as revision with the next write to be sure nobody changed the deck in between