Developers

A JSON API at /api/v1 and widgets you can drop into any website. The full description is at /api/v1/openapi.json (OpenAPI 3.1).

Widgets

Paste one tag where the widget should appear. Replace marina-slug with the marina's name from its page address (for example, /marinas/kemah-boardwalk-marina).

Book a slip

Available slips with prices and a Request button. Requests count as bookings from your widget.

<script src="https://dockpact.com/widget.js" data-marina="marina-slug" data-widget="booking" async></script>

Marina card

Photo, name, slips, rating and availability, linking to the marina page.

<script src="https://dockpact.com/widget.js" data-marina="marina-slug" data-widget="card" async></script>

Fuel prices

Today's fuel prices at the marina.

<script src="https://dockpact.com/widget.js" data-marina="marina-slug" data-widget="fuel" async></script>

Reviews badge

Average rating and review count, with verified stays.

<script src="https://dockpact.com/widget.js" data-marina="marina-slug" data-widget="reviews" async></script>

Using the API

Public reads need no key. They are rate limited per IP address (about 120 a minute; search 60).
For a boater's own data, get tokens from POST /api/v1/auth/token and send Authorization: Bearer <accessToken>. Access tokens last 15 minutes; refresh them with POST /api/v1/auth/refresh.
Errors are JSON: { "code": "...", "message": "...", "field": "..." }. 400 means the input is wrong (field says where), 422 means a business rule refused it, 429 means slow down.
Dates are YYYY-MM-DD in the marina's time zone; money is in cents.

Endpoints

Marinas

GET /api/v1/metros
Areas we cover
GET /api/v1/metros/{slug}/marinas
Marina cards in an area: price or estimate, availability badge, rating
GET /api/v1/search
Search marinas by place, map area and boat size; ranked by fit, then distance
GET /api/v1/marinas/{slug}
A marina page: details, photos, amenities, fuel prices, review summary, spaces and availability summary
GET /api/v1/marinas/{slug}/slips
Docks and spaces for a slip map
GET /api/v1/slips/{id}/availability
Free day ranges for one space (at most two years)

Booking

POST /api/v1/quotes
Price a stay and check it can be requested
POST /api/v1/booking-requests Sign-in
Request a space; it is held while the marina decides
POST /api/v1/booking-requests/{id}/cancel Sign-in
Withdraw a waiting request
GET /api/v1/my/booking-requests Sign-in
The caller's requests

Boats

GET /api/v1/my/vessels Sign-in
The caller's boats
POST /api/v1/my/vessels Sign-in
Add a boat
PATCH /api/v1/my/vessels/{id} Sign-in
Change a boat
DELETE /api/v1/my/vessels/{id} Sign-in
Remove a boat
GET /api/v1/my/launches Sign-in
The caller's launch and retrieve requests, and the boats they can ask for
POST /api/v1/my/launches Sign-in
Ask the marina to launch or bring back a boat
DELETE /api/v1/my/launches/{id} Sign-in
Withdraw a launch request

Contact

POST /api/v1/leads
Ask about a slip at a marina
POST /api/v1/removal-requests
Ask for a listing to be removed

Claims

POST /api/v1/claims
Start a marina claim
GET /api/v1/claims/{token}
The claimant's view of their claim (signed status link)
POST /api/v1/claims/{token}/evidence
Upload one proof document (multipart: docType, file); stored encrypted
POST /api/v1/claims/{token}/verify-phone
Text a code to the listing's phone ({action: "send"}) or confirm it ({code})

Chat

GET /api/v1/chat/conversations Sign-in
The caller's conversations
POST /api/v1/chat/conversations Sign-in
Start a conversation with support or a marina
GET /api/v1/chat/conversations/{id} Sign-in
Messages, oldest first
POST /api/v1/chat/conversations/{id}/messages Sign-in
Send a message
GET /api/v1/chat/stream Sign-in
Live messages as Server-Sent Events (?conversation=<id>)
POST /api/v1/chat/conversations/{id}/read Sign-in
Clear the caller's unread count (?marina=slug for the marina side)

Sign-in

POST /api/v1/auth/token
Get an access token (15 minutes) and refresh token (60 days)
POST /api/v1/auth/refresh
Swap a refresh token for a new pair
POST /api/v1/auth/revoke
Sign a device out
POST /api/v1/auth/login
Password sign-in for the website (sets a session cookie)
POST /api/v1/auth/password Sign-in
Change password
GET /api/v1/auth/me Sign-in
The signed-in user
POST /api/v1/auth/logout
Sign the browser out (deletes the session)
POST /api/v1/auth/magic-link
Email a one-time sign-in link ({email}); same answer whether or not the account exists
POST /api/v1/auth/magic-link/verify
Use an emailed sign-in link ({token})
POST /api/v1/auth/password-reset
Email a password reset link ({email}); same answer either way
POST /api/v1/auth/password-reset/confirm
Set a new password from a reset link ({token, password}) and sign in

Saved marinas

GET /api/v1/my/saved-marinas Sign-in
The caller's saved marinas as cards, newest first
PUT /api/v1/my/saved-marinas/{marinaId} Sign-in
Save a marina
DELETE /api/v1/my/saved-marinas/{marinaId} Sign-in
Remove a saved marina

Tenant portal

GET /api/v1/my/leases/{id} Sign-in
One of the caller's leases with its documents
GET /api/v1/my/billing Sign-in
Marinas rented from, leases, invoices, cards and payments
POST /api/v1/my/invoices/{id}/pay Sign-in
A Stripe Checkout page for an invoice balance (card, Apple Pay, Google Pay)
POST /api/v1/my/tenancies/{id}/card Sign-in
A Stripe Checkout page that saves a new card for autopay
GET /api/v1/my/insurance Sign-in
Insurance documents on file
POST /api/v1/my/insurance Sign-in
Send proof of insurance to a marina (multipart: file, tenantId, expiresOn, carrier, number, liabilityCents, vesselId)
GET /api/v1/my/alerts Sign-in
Notices and storm or safety alerts from the caller's marinas
GET /api/v1/my/lease-documents/{id} Sign-in
A lease PDF, for its tenant only
POST /api/v1/my/lease-documents/{id}/sign Sign-in
Sign a lease document by typing the full name and ticking consent
POST /api/v1/my/leases/{id}/checkout Sign-in
A Stripe Checkout page for a signed lease's first payment
POST /api/v1/pay/{token}
A Stripe Checkout page for an invoice balance, from the signed link in the invoice email
POST /api/v1/estimates/{token}
Approve (typed name) or decline a work estimate from the signed link in the email
POST /api/v1/card/{token}
A Stripe page to save a new autopay card, from the signed link in the card-declined email

Mobile app

POST /api/v1/my/push-tokens Sign-in
Register this phone for notifications (Expo push token)
DELETE /api/v1/my/push-tokens Sign-in
Stop notifications to this phone

Service

GET /api/v1/health
Liveness: database and Redis
GET /api/v1/openapi.json
This API description
POST /api/v1/webhooks/stripe
Stripe platform and Connect webhook events (Stripe-Signature checked; each event stored once)

Marina admin

POST /api/v1/invites/{token}/accept Sign-in
Join a marina's team from an invite link
GET /api/v1/manage/{marina} Sign-in
The marina's profile
PATCH /api/v1/manage/{marina} Sign-in
Save profile fields
PATCH /api/v1/manage/{marina}/settings Sign-in
Save settings
GET /api/v1/manage/{marina}/dashboard Sign-in
Dashboard numbers
GET /api/v1/manage/{marina}/onboarding Sign-in
Go-live checklist
GET /api/v1/manage/{marina}/docks Sign-in
Docks
POST /api/v1/manage/{marina}/docks Sign-in
Add a dock
PATCH /api/v1/manage/{marina}/docks/{id} Sign-in
Change a dock
DELETE /api/v1/manage/{marina}/docks/{id} Sign-in
Remove an empty dock
GET /api/v1/manage/{marina}/slips Sign-in
Spaces
POST /api/v1/manage/{marina}/slips Sign-in
Add a space
PATCH /api/v1/manage/{marina}/slips/{id} Sign-in
Change a space (active: false deactivates)
DELETE /api/v1/manage/{marina}/slips/{id} Sign-in
Remove a space with no history
GET /api/v1/manage/{marina}/slips/{id}/addons Sign-in
Options on a space
PUT /api/v1/manage/{marina}/slips/{id}/addons Sign-in
Replace the options on a space
PATCH /api/v1/manage/{marina}/slips/status Sign-in
Set the status of many spaces
GET /api/v1/manage/{marina}/rate-cards Sign-in
Prices
POST /api/v1/manage/{marina}/rate-cards Sign-in
Add a price
PUT /api/v1/manage/{marina}/rate-cards/{id} Sign-in
Replace a price
DELETE /api/v1/manage/{marina}/rate-cards/{id} Sign-in
Remove a price
PUT /api/v1/manage/{marina}/prices/bulk Sign-in
One price for spaces by dock, length, type or selection
GET /api/v1/manage/{marina}/addon-types Sign-in
Add-on price list
POST /api/v1/manage/{marina}/addon-types Sign-in
Add an option
PATCH /api/v1/manage/{marina}/addon-types/{id} Sign-in
Change an option
DELETE /api/v1/manage/{marina}/addon-types/{id} Sign-in
Retire an option
PUT /api/v1/manage/{marina}/availability Sign-in
Open or close dates for booking (live marinas)
GET /api/v1/manage/{marina}/calendar Sign-in
Slips by days
GET /api/v1/manage/{marina}/next-openings Sign-in
Spaces by the date they next free up
GET /api/v1/manage/{marina}/booking-requests Sign-in
Requests inbox
GET /api/v1/manage/{marina}/booking-requests/{id} Sign-in
One request
POST /api/v1/manage/{marina}/booking-requests/{id}/accept Sign-in
Accept: tenant, draft lease, lease to sign
POST /api/v1/manage/{marina}/booking-requests/{id}/decline Sign-in
Decline with a reason
GET /api/v1/manage/{marina}/leases Sign-in
Leases
POST /api/v1/manage/{marina}/leases/{id}/send Sign-in
Send the lease to sign
POST /api/v1/manage/{marina}/leases/{id}/cancel Sign-in
Cancel an unpaid lease
GET /api/v1/manage/{marina}/leases/{id}/documents Sign-in
A lease's documents
GET /api/v1/manage/{marina}/leases/renewals Sign-in
Leases that would renew into a season, with the new rent
POST /api/v1/manage/{marina}/leases/renewals Sign-in
Create renewals for a season at a rate change and send them all to sign
GET /api/v1/manage/{marina}/leads Sign-in
Slip enquiries for this marina
PATCH /api/v1/manage/{marina}/leads/{id} Sign-in
Mark a lead new, contacted or closed
POST /api/v1/manage/{marina}/leads/{id}/convert Sign-in
Make a lead a customer
GET /api/v1/manage/{marina}/lease-documents/{id} Sign-in
A lease PDF
GET /api/v1/manage/{marina}/lease-template Sign-in
The lease text
PUT /api/v1/manage/{marina}/lease-template Sign-in
Save a new lease text version
GET /api/v1/manage/{marina}/team Sign-in
Team and pending invitations
PATCH /api/v1/manage/{marina}/team/{id} Sign-in
Change a member's role
DELETE /api/v1/manage/{marina}/team/{id} Sign-in
Remove a member
POST /api/v1/manage/{marina}/invites Sign-in
Invite someone
DELETE /api/v1/manage/{marina}/invites/{id} Sign-in
Withdraw an invitation
GET /api/v1/manage/{marina}/tenants Sign-in
Customers (format=csv for a spreadsheet with every exportable field and the marina's own fields)
POST /api/v1/manage/{marina}/tenants Sign-in
Add a customer
GET /api/v1/manage/{marina}/tenants/{id} Sign-in
A customer's page
PATCH /api/v1/manage/{marina}/tenants/{id} Sign-in
Change a customer
GET /api/v1/manage/{marina}/tenants/{id}/statement Sign-in
Statement with running balance
GET /api/v1/manage/{marina}/tenants/{id}/notes Sign-in
The customer's notes and contact log, newest first
POST /api/v1/manage/{marina}/tenants/{id}/notes Sign-in
Add a note to a customer
POST /api/v1/manage/{marina}/tenants/{id}/contacts Sign-in
Record a call, text, chat or visit with a customer
DELETE /api/v1/manage/{marina}/notes/{id} Sign-in
Delete a note you wrote
GET /api/v1/manage/{marina}/custom-fields Sign-in
The marina's own fields for customers, boats, spaces and leases
POST /api/v1/manage/{marina}/custom-fields Sign-in
Add a field
PATCH /api/v1/manage/{marina}/custom-fields/{id} Sign-in
Change or switch off a field
GET /api/v1/manage/{marina}/tenants/{id}/fields Sign-in
A customer's own-field values
PUT /api/v1/manage/{marina}/tenants/{id}/fields Sign-in
Save a customer's own-field values
GET /api/v1/manage/{marina}/vessels/{id}/fields Sign-in
A boat's own-field values
PUT /api/v1/manage/{marina}/vessels/{id}/fields Sign-in
Save a boat's own-field values
GET /api/v1/manage/{marina}/slips/{id}/fields Sign-in
A space's own-field values
PUT /api/v1/manage/{marina}/slips/{id}/fields Sign-in
Save a space's own-field values
GET /api/v1/manage/{marina}/leases/{id}/fields Sign-in
A lease's own-field values
PUT /api/v1/manage/{marina}/leases/{id}/fields Sign-in
Save a lease's own-field values
POST /api/v1/manage/{marina}/occupancies Sign-in
Move a customer in
PATCH /api/v1/manage/{marina}/occupancies/{id} Sign-in
Check in, end, extend or move a stay
GET /api/v1/manage/{marina}/occupancies/{id}/checkout Sign-in
What is left when a customer leaves: active gate codes and passes, and the deposit
POST /api/v1/manage/{marina}/occupancies/{id}/deposit Sign-in
Settle the deposit after the stay ends: apply part to the balance, give part back, keep the rest
GET /api/v1/manage/{marina}/occupancies/{id}/absences Sign-in
Days the customer is away
POST /api/v1/manage/{marina}/occupancies/{id}/absences Sign-in
Add days away; with a return date the slip can be sold for short stays
PATCH /api/v1/manage/{marina}/absences/{id} Sign-in
Change the days away
DELETE /api/v1/manage/{marina}/absences/{id} Sign-in
Remove days away (not once short stays were sold in them)
GET /api/v1/manage/{marina}/recurring-charges Sign-in
A customer's recurring charges
POST /api/v1/manage/{marina}/recurring-charges Sign-in
Add a recurring charge (months already run are billed at once)
PATCH /api/v1/manage/{marina}/recurring-charges/{id} Sign-in
Change or stop a recurring charge
GET /api/v1/manage/{marina}/work-orders Sign-in
Work orders
POST /api/v1/manage/{marina}/work-orders Sign-in
Start a work order for a customer
GET /api/v1/manage/{marina}/work-orders/{id} Sign-in
A work order with its lines
PATCH /api/v1/manage/{marina}/work-orders/{id} Sign-in
Change a work order or its status
POST /api/v1/manage/{marina}/work-orders/{id}/lines Sign-in
Add a part or labour line
DELETE /api/v1/manage/{marina}/work-orders/{id}/lines/{lineId} Sign-in
Remove a line before approval
POST /api/v1/manage/{marina}/work-orders/{id}/send Sign-in
Email the estimate to approve by typing a name
GET /api/v1/manage/{marina}/launches Sign-in
The launch queue for a day
POST /api/v1/manage/{marina}/launches Sign-in
Queue a launch or retrieve for a customer
PATCH /api/v1/manage/{marina}/launches/{id} Sign-in
Move a launch request along, re-time or re-order it
POST /api/v1/manage/{marina}/yard-bookings Sign-in
Book the lift or crane
PATCH /api/v1/manage/{marina}/yard-bookings/{id} Sign-in
Move, re-assign or close a yard booking
GET /api/v1/manage/{marina}/tenants/{id}/access Sign-in
The customer's gate codes, fobs and passes
POST /api/v1/manage/{marina}/tenants/{id}/access Sign-in
Give the customer a gate code, fob or pass
POST /api/v1/manage/{marina}/tenants/{id}/access/revoke Sign-in
Revoke some or all of the customer's credentials
GET /api/v1/manage/{marina}/today Sign-in
Arrivals and departures
GET /api/v1/manage/{marina}/charges Sign-in
Charges not yet invoiced
POST /api/v1/manage/{marina}/charges Sign-in
Add a charge
DELETE /api/v1/manage/{marina}/charges/{id} Sign-in
Void an uninvoiced charge
GET /api/v1/manage/{marina}/invoices Sign-in
Invoices
POST /api/v1/manage/{marina}/invoices Sign-in
Invoice a customer now
GET /api/v1/manage/{marina}/invoices/{id} Sign-in
One invoice
POST /api/v1/manage/{marina}/invoices/{id}/void Sign-in
Void an unpaid invoice
POST /api/v1/manage/{marina}/payments Sign-in
Record a payment
GET /api/v1/manage/{marina}/receivables Sign-in
Receivables aging
GET /api/v1/manage/{marina}/expenses Sign-in
Expenses (json or csv)
POST /api/v1/manage/{marina}/expenses Sign-in
Add an expense
PATCH /api/v1/manage/{marina}/expenses/{id} Sign-in
Change an expense
DELETE /api/v1/manage/{marina}/expenses/{id} Sign-in
Remove an expense
POST /api/v1/manage/{marina}/expenses/{id}/attachment Sign-in
Attach a receipt (multipart file)
GET /api/v1/manage/{marina}/expenses/{id}/attachment Sign-in
The receipt
GET /api/v1/manage/{marina}/waitlist Sign-in
The waitlist, offers first, then queue order
POST /api/v1/manage/{marina}/waitlist Sign-in
Add someone to the waitlist
PATCH /api/v1/manage/{marina}/waitlist/{id} Sign-in
Change a waitlist entry or its place
POST /api/v1/manage/{marina}/waitlist/{id}/offer Sign-in
Offer an open space (email, 48 hours to answer)
POST /api/v1/manage/{marina}/waitlist/{id}/answer Sign-in
Record an answer, remove, or requeue
GET /api/v1/manage/{marina}/waitlist/matches Sign-in
Who on the waitlist fits a space
GET /api/v1/manage/{marina}/meters Sign-in
Meters with their latest reading
POST /api/v1/manage/{marina}/meters Sign-in
Add a meter to a space
PATCH /api/v1/manage/{marina}/meters/{id} Sign-in
Change a meter's price, multiplier or switch it off
GET /api/v1/manage/{marina}/meters/{id}/readings Sign-in
A meter's readings, newest first
POST /api/v1/manage/{marina}/meters/{id}/readings Sign-in
Record a reading (flagged when below the last)
DELETE /api/v1/manage/{marina}/meter-readings/{id} Sign-in
Remove an unbilled reading
POST /api/v1/manage/{marina}/invoices/{id}/credit Sign-in
Credit part of an invoice
POST /api/v1/manage/{marina}/payments/{id}/refund Sign-in
Refund all or part of a payment (card payments through Stripe)
GET /api/v1/manage/{marina}/tax-rates Sign-in
The marina's tax rates
POST /api/v1/manage/{marina}/tax-rates Sign-in
Add a tax rate
PATCH /api/v1/manage/{marina}/tax-rates/{id} Sign-in
Change or switch off a tax rate
GET /api/v1/manage/{marina}/broadcasts Sign-in
Messages sent to tenants
POST /api/v1/manage/{marina}/broadcasts Sign-in
Send a notice or an urgent storm or safety alert to tenants (email, text and phone notification)
GET /api/v1/manage/{marina}/expense-categories Sign-in
Expense categories
POST /api/v1/manage/{marina}/expense-categories Sign-in
Add a category
GET /api/v1/manage/{marina}/reports/{name} Sign-in
A report: overview, pnl, rent-roll, receivables, inventory, revenue, tax, or pack.pdf
GET /api/v1/manage/{marina}/imports Sign-in
Recent imports
POST /api/v1/manage/{marina}/imports Sign-in
Upload a slip or customer file (multipart)
GET /api/v1/manage/{marina}/imports/{id} Sign-in
Import preview
PATCH /api/v1/manage/{marina}/imports/{id} Sign-in
Map columns and validate
POST /api/v1/manage/{marina}/imports/{id}/commit Sign-in
Commit a validated import
GET /api/v1/manage/{marina}/map-sources Sign-in
Uploaded maps and traced suggestions
POST /api/v1/manage/{marina}/map-sources Sign-in
Upload a map to trace (multipart) or capture one from a web page ({url})
GET /api/v1/manage/{marina}/map-sources/{id}/file Sign-in
An uploaded map file
PUT /api/v1/manage/{marina}/layout Sign-in
Save the slip map
GET /api/v1/manage/{marina}/membership Sign-in
Membership, Stripe connection and ledger
POST /api/v1/manage/{marina}/membership/checkout Sign-in
Pay for the membership
POST /api/v1/manage/{marina}/stripe/connect Sign-in
Connect Stripe to take tenants' payments

Operations

GET /api/v1/ops/metros
Metros in order, with marina counts
POST /api/v1/ops/metros
Add a metro
PUT /api/v1/ops/metros/order
Set the metro order
PATCH /api/v1/ops/metros/{id}
Change a metro
DELETE /api/v1/ops/metros/{id}
Remove a metro with no marinas
GET /api/v1/ops/marinas
Every marina, filtered
POST /api/v1/ops/marinas
Create a seeded marina from research
POST /api/v1/ops/seed/run
Load the bundled seed data again (metros, waters, expense categories, plan, researched marinas); marinas their owners edited are kept
GET /api/v1/ops/marinas/{id}
A marina with research fields, team, membership, claims and tasks
PATCH /api/v1/ops/marinas/{id}
Change any field ops may set
POST /api/v1/ops/marinas/{id}/suspend
Suspend or restore a listing
POST /api/v1/ops/marinas/{id}/audit
Read the marina's website again and suggest checklist facts for review
GET /api/v1/ops/marinas/{id}/facts
Website facts waiting for review, the approved ones, and the last website reads
POST /api/v1/ops/facts/{id}
Approve (optionally corrected) or reject a website fact
GET /api/v1/ops/research
Research tasks and progress per metro
POST /api/v1/ops/research
Add research tasks to a marina
PATCH /api/v1/ops/research/{id}
Update a research task
GET /api/v1/ops/invites
Claim invites with opened and claimed
POST /api/v1/ops/invites
Create a claim invite link (shown once) and email it
DELETE /api/v1/ops/invites/{id}
Revoke an unused claim invite
GET /api/v1/ops/claims
The claim queue
GET /api/v1/ops/claims/{id}
A claim with its documents and checks
POST /api/v1/ops/claims/{id}/approve
Approve a claim
POST /api/v1/ops/claims/{id}/reject
Reject a claim with a reason
POST /api/v1/ops/claims/{id}/more-docs
Ask the claimant for another document
POST /api/v1/ops/claims/{id}/reread
Read and score the claim's documents again
GET /api/v1/ops/claims/{id}/evidence/{evidenceId}
A proof document (logged)
GET /api/v1/ops/removals
Listing removal requests
GET /api/v1/ops/removals/{id}
One removal request
PATCH /api/v1/ops/removals/{id}
Review, remove, keep or close a removal request
GET /api/v1/ops/audit
Search the audit log
GET /api/v1/ops/notifications
The ops bell
POST /api/v1/ops/notifications/read
Mark bell items read
GET /api/v1/ops/leads
Slip enquiries
PATCH /api/v1/ops/leads/{id}
Set a platform lead's status
GET /api/v1/ops/memberships
Plans, memberships by status and monthly revenue
PATCH /api/v1/ops/plans/{id}
Change a plan
GET /api/v1/ops/ledger
Marinas with an open balance
GET /api/v1/ops/ledger/{marina}
One marina's ledger and settlements
POST /api/v1/ops/ledger/{marina}/adjustments
Add a manual adjustment
POST /api/v1/ops/ledger/{marina}/settle
Settle a marina now
GET /api/v1/ops/settlements
Settlements waiting on a person
POST /api/v1/ops/settlements/{id}/approve
Approve a payout over the automatic limit
POST /api/v1/ops/settlements/{id}/paid
Record a settlement paid by hand
GET /api/v1/ops/imports
Every marina's imports and map traces
POST /api/v1/ops/imports/{id}/rerun
Commit a failed import again
POST /api/v1/ops/map-sources/{id}/retrace
Trace an uploaded map again
GET /api/v1/ops/conversations
The support inbox
POST /api/v1/ops/conversations/{id}/status
Close or reopen a conversation