Skip to main content
GET
Read one step

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
index
integer
required

The step's index; 0 is the join screen

Required range: 0 <= x <= 9007199254740991

Response

OK

index
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
step
object
required

The mandatory opener: the code and QR while the room fills. Always first.

elements
object[]
required
overlaps
object[]
required

Pairs of elements that sit on top of each other; empty when nothing overlaps

warnings
object[]
required

What on this slide will not read well: a card too small to read, a card or text box over another

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