Skip to content
Quikstik Developers
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Getting started
Introduction
Quickstart: storefront
Authentication
Conventions & errors
Concepts
Tenants and keys
Catalog: offerings and variants
Availability and capacity
Booking lifecycle
Money: obligations, captures, refunds
Customers and readiness
Content
API reference
Overview
Catalog
Overview
List offerings
GET
Provision an offering and its variants
POST
Read offering
GET
Read offering variant
GET
Availability
Overview
Request an availability snapshot
POST
The week strip — per-date departures, riders, balance due and worst conditions
GET
The Day — one merchant-local date's departures, parties, riders, readiness and balances
GET
Checkout
Overview
Create booking intent
POST
Read booking intent
GET
Storefront book-and-pay (customer-present)
POST
Bookings
Overview
List bookings by departure window, confirmation number, buyer email, or free text
GET
Read confirmed booking
GET
Append an amendment to the booking's agreement
POST
Assign a unit (bike) to a rider
POST
Take a rider's unit away (idempotent)
DELETE
Check the party in (idempotent)
POST
Mark the party a no-show (idempotent)
POST
The booking's policy snapshot and what it allows now
GET
Re-resolve one booking's policy snapshot, with a reason
POST
What cancelling or rebooking would do to the money — before the confirm tap
GET
Ask the lead for the missing waivers or heights — one email
POST
Reopen a done / no-show booking
POST
Resend the booking confirmation
POST
Cancel a single booking and request its refund
POST
Manifest projection for a Context
GET
Cancel a whole departure and fully refund every active booking on it
POST
Eagerly publish a variant's departures from its recurrence rule
POST
Board several riders at once (multiselect)
POST
Board every rider not yet boarded
POST
Boarding mode — every rider on a departure
GET
Rebook (move) a booking to a new departure, with its price revision
POST
Guest links
Overview
Load a balance link's page (booking facts and the live balance)
GET
Pay the live balance with a card the guest presents
POST
Read a group-checkout share by capability token
GET
Settle a group-checkout share over the processor rail
POST
Load a proposal checkout context
GET
Finalize a proposal (charge-only)
POST
Customer roster completion on the checkout page (warm carts)
POST
The readiness flow a capability token resolves to
GET
Record a readiness outcome through a capability link
POST
Provisioning
Overview
Read the capacity tree of one merchant date
GET
Configure a capacity pool
POST
Explicitly re-parent a capacity pool
POST
Set the tenant's T-minus cancellation schedule
POST
Set merchant tax configuration
POST
Set an offering variant's capacity-keying policy
POST
Read back a variant's price book and recurrence (mirror of the PUT)
GET
Set variant pricing schedule
PUT
List the tenant's policy documents (all scopes, all versions)
GET
Set a scope's policy document (new version; the old one retires)
PUT
Retire a scope's live policy document (it falls back to the next scope)
DELETE
List the tenant's registered units (the fleet)
GET
Register an identified unit
POST
Record an equipment lifecycle event for a unit
POST
Move a unit through its lifecycle
POST
Record a stock movement on a (sku, location) line
POST
Payments & balances
Overview
Cancel an open balance link
POST
Capture payment over the processor rail
POST
Open receivables behind the summary, bucket order then largest due first
GET
Executed refunds recorded in core, newest first
GET
Money tab summary — receivables by departure date, executed refunds, decisions waiting
GET
Read the balance owed on a booking obligation
GET
Mint a single-use link that collects an obligation's live balance
POST
Operator off-session settlement of a deposit's remaining balance on the vaulted card
POST
Content
Overview
Read a merchant's published cancellation schedule (public)
GET
List this merchant's content types with full schemas (secret key).
GET
Create or evolve a content type (secret key).
PUT
List entries of a content type live on this merchant's surface.
GET
Create an entry of this content type (secret key).
POST
One live entry by slug, including its body tree.
GET
Revise an entry under an If-Match sequence precondition (secret key).
PUT
Publish or retract on a (channel, locale) surface (secret key).
POST
Media metadata list (newest first).
GET
One media doc by wire id (tenant-issued string id or uuid).
GET
Upsert media metadata by wire id (secret key).
PUT
A merchant's resolved cancellation and change policy (public,)
GET
Singleton site-settings document fields, or an empty object when unset.
GET
Team & tenant
Overview
The tenant's roster — humans and agents (what `@name` resolves against)
GET
Register (or rotate) the tenant's OTA channel — Bokun keys + activity map
POST
Disable the tenant's OTA channel
DELETE
Authentication
Overview
Request a magic-link login email for a customer (person) account
POST
Exchange a customer magic-link token for a first-party person session
POST
List the caller's device sessions
GET
Trade a device refresh token for a fresh session JWT
POST
Request a magic-link login email
POST
Exchange a presented magic-link token for a first-party session
POST
Who the session is and what it may do
GET
Mint an operator API key (Admin/Owner session only)
POST
Revoke an operator API key (Admin/Owner session only)
POST
Customers
Overview
Search guests — one result per human
GET
One guest with every booking, thread and held send
GET
Add a Person to an Organization with a domain role
POST
Supersede a membership (end its window or record a new one)
POST
Create a customer-side organization (household or corporate account)
POST
Archive an organization
POST
Set or clear an organization's parent
POST
Define a tenant-scoped participant trait
POST
Record (or correct) a typed trait value for a participant
POST
Attach a participant role-instance to a Context
POST
Check one rider in (idempotent) — the primitive
POST
Take a rider's check-in back (idempotent)
POST
Derived readiness gate for a participant
GET
Mint a prefilled SmartWaiver signing link for one participant (operator-fired)
POST
Create a durable customer identity
POST
A Person's correspondence log
GET
The identities a person owns
GET
Attach an identity to a person, with evidence (session only)
POST
Merge this person into another, with evidence (session only)
POST
A Person's participations across Contexts
GET
Correct a Person's mutable profile
POST
Undo a merge of this person into another, with evidence (session only)
POST
Record the immutable outcome of a requirement for a participant
POST
Correct an attestation (append/supersede)
POST
Mint a readiness capability link for a participant
POST
Configure a readiness requirement
POST
Assert a typed relationship edge between two subjects
POST
Supersede a relationship edge (extend or close its window)
POST
Customer account
Overview
Cancel the whole booking as its buyer, at the refund the guest was shown
POST
What cancelling this booking now would refund, and until when that figure holds
GET
Price moving this booking to another departure, on the server, and remember it 15 minutes
POST
Redeem a rebook quote — move the booking
POST
Mint the single-use pay link for the live balance of one of my bookings
POST
Fix a participant's height or display name
POST
The signed-in customer's own participations plus those they head
GET
Per-requirement readiness for a participant the customer may see
GET
Conditions
Overview
List the tenant's departure points
GET
Declare a departure point
POST
Edit a departure point
PATCH
Pull every weather source for a point and date now
POST
List the tenant's rules (enabled or not), oldest first
GET
Create a rule
POST
Edit a rule, including enabling / disabling it
PATCH
The blend and the departure states for a local day
GET
Reference notes
Status of this documentation
Changelog
GitHub
Select theme
Dark
Light
Auto
Changelog
2026-11-01
Section titled “2026-11-01”
First publication of developer documentation: guides, concepts, and a reference generated from the live contracts (133 operations across 13 sections).
