Skip to main content
GET
/
api
/
v1
/
boards
List pending boards
curl --request GET \
  --url https://api.example.com/api/v1/boards/
[
  {
    "amount_sat": 1,
    "funding_tx": {
      "tx": "<string>",
      "txid": "<string>"
    },
    "movement_id": 1,
    "vtxos": [
      "<string>"
    ]
  }
]

Response

Returns all pending boards

​
amount_sat
integer<int64>
required

The amount of the board.

Required range: x >= 0
​
funding_tx
object
required

The funding transaction. This is the transaction that has to be confirmed onchain for the board to succeed.

​
movement_id
integer<int32>
required

The ID of the movement associated with this board.

Required range: x >= 0
​
vtxos
string[]
required

The IDs of the VTXOs that were created in this board.

Currently, this is always a vector of length 1