Skip to main content
POST
Create a new list

Authorizations

X-Api-Key
string
header
required

Body

application/json
list_rate_id
string
required

List rate id of a list.

Example:

"5f8d0f8b9d2b3b0017b6d8a0"

send_notification
boolean
default:false

Notify the QR for list

Example:

false

list
object

Response

OK

data
object

The wire contract for a list, AT THE LATEST VERSION.

This is the single source of truth: toListResponse is annotated to return it (so the code cannot drift from it without a compile error), and the OpenAPI spec + docs + breaking-change gate are all generated from it.

Dates are ISO-8601 strings — the real wire form res.json produces from the underlying Moment values.

Remaining nested relations are unknown for now; in the full rollout each gets its own versioned response contract (recursively), at which point they become typed $refs here.

success
boolean