HTTP API · OPENAPI 3.1
Endpoint reference
Search the implemented routes by method, path, purpose, or request field. Expand an operation to see authentication, parameters, request fields, and documented response codes.
88 operations, checked against the Go routerDownload the OpenAPI YAML
System
4 routesGET/healthLiveness checkPublic
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200API process is running
GET/readyReadiness checkPublic
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Dependencies are ready or readiness checks are disabled
GET/api/v1API version informationPublic
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Version information
GET/metricsExport process metricsPublic
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Prometheus text metrics
Authentication
13 routesPOST/api/v1/auth/registerRegister a member accountPublic
JSON request bodySchema: RegisterRequest
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
username | string | Yes | 3–32 chars | — |
email | string · email | Yes | — | — |
password | string · password | Yes | 8–128 chars | — |
display_name | string | No | 0–120 chars | — |
locale | string | No | — | — |
Documented responses
201Account created pending verification422Validation failed
POST/api/v1/auth/loginValidate email and password and send a sign-in code by emailPublic
JSON request bodySchema: LoginRequest
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
email | string · email | Yes | — | — |
password | string · password | Yes | — | — |
Documented responses
202Sign-in code sent; session is not created yet401Invalid credentials429Sign-in code request throttled503Email delivery is unavailable
POST/api/v1/auth/login/verifyVerify a sign-in code and create the sessionPublic
JSON request body
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
email | string · email | Yes | — | — |
code | string | Yes | 6–6 chars | — |
Documented responses
200Session created401Code invalid or expired
POST/api/v1/auth/login/otp/resendResend a sign-in code for an active accountPublic
JSON request body
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
email | string · email | Yes | — | — |
Documented responses
202Accepted if account is active429Request throttled
POST/api/v1/auth/refreshRotate a refresh tokenPublic
JSON request bodySchema: RefreshRequest
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
refresh_token | string | Yes | 1–∞ chars | — |
Documented responses
200Session rotated401Invalid or revoked refresh token
POST/api/v1/auth/logoutRevoke a refresh tokenPublic
JSON request bodySchema: RefreshRequest
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
refresh_token | string | Yes | 1–∞ chars | — |
Documented responses
200Session revoked401Invalid or revoked refresh token
POST/api/v1/auth/verify-emailVerify an email OTPPublic
JSON request body
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
user_id | string | Yes | — | — |
code | string | Yes | 4–8 chars | — |
Documented responses
200Email verified422OTP invalid or expired
POST/api/v1/auth/verification/resendRequest another email verification codePublic
JSON request body
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
email | string · email | Yes | — | — |
Documented responses
202Verification sent if the account is pending
GET/api/v1/auth/meGet the authenticated userBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Current user401Authentication required
PATCH/api/v1/auth/meUpdate the authenticated user's username and display nameBearer token
JSON request body
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
username | string | Yes | 3–32 chars | — |
display_name | string | Yes | 1–100 chars | — |
Documented responses
200Profile updated401Authentication required409Username is already in use422Invalid profile fields
DELETE/api/v1/auth/meDelete the authenticated user's accountBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Account deleted401Authentication required
POST/api/v1/auth/password-reset/requestRequest a password reset codePublic
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
202Accepted without account enumeration
POST/api/v1/auth/password-reset/confirmConfirm a password reset codePublic
JSON request body
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
email | string · email | Yes | — | — |
code | string | Yes | 4–8 chars | — |
password | string · password | Yes | 8–128 chars | — |
Documented responses
200Password reset422Invalid or expired reset code
Catalog and providers
15 routesGET/api/v1/catalog/servicesList active servicesPublic
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Active catalog services
GET/api/v1/catalog/categoriesList active business listing categoriesPublic
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Active categories usable by POST /api/v1/listings
POST/api/v1/providersRegister a provider profileBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
201Provider created pending approval401Authentication required422Invalid provider fields
GET/api/v1/listingsSearch published, approved, subscribed business listingsPublic
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
q | query | No | string | — |
category_id | query | No | string | — |
limit | query | No | integer | — |
offset | query | No | integer | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Published businesses with active menu items and integer minor-unit prices400Pagination parameters are not integers422Pagination parameters are outside supported bounds
POST/api/v1/listingsCreate a draft business listingBearer token
JSON request body
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
provider_id | string | Yes | — | — |
category_id | string | Yes | — | — |
name | string | Yes | — | — |
description | string | No | — | — |
Documented responses
201Listing created as draft401Authentication required404Caller does not own a provider profile422Invalid listing fields
GET/api/v1/listings/{id}/contactResolve the provider contact for an active listingBearer token
Authenticated endpoint; only approved, published, currently subscribed listings return a contact user ID.
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Provider contact for opening a chat401Authentication required404Listing is unavailable for contact
PATCH/api/v1/providers/meUpdate the authenticated provider profileBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Provider profile updated401Authentication required404Provider profile not found
GET/api/v1/listings/{id}Read an active, published business listingPublic
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Listing details including active menu items404Listing is not public or does not exist
PATCH/api/v1/listings/{id}Update an owned business listingBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Listing updated404Listing not found or caller is not its owner
DELETE/api/v1/listings/{id}Deactivate an owned business listingBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Listing deactivated404Listing not found or caller is not its owner
POST/api/v1/listings/{id}/menu-itemsCreate a menu item for an owned listingBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
201Menu item created404Listing not found or caller is not its owner
PATCH/api/v1/menu-items/{id}Update a menu item for an owned listingBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Menu item updated404Menu item not found or caller is not its owner
DELETE/api/v1/menu-items/{id}Deactivate a menu item for an owned listingBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Menu item deactivated404Menu item not found or caller is not its owner
GET/api/v1/providers/me/dashboardRead the authenticated provider dashboardBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Dashboard returned403Provider access required
POST/api/v1/providers/me/salesRecord a manual off-platform sale for the authenticated providerBearer token
JSON request body
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
amount | integer | Yes | 0 to ∞ | — |
currency | string | Yes | 3–3 chars | — |
occurred_at | string · date-time | No | — | — |
description | string | Yes | 1–500 chars | — |
customer_label | string | No | 0–120 chars | — |
Documented responses
201Manual sale recorded403Provider access required422Invalid sale fields
Orders and payments
10 routesGET/api/v1/ordersList orders visible to the authenticated customer and providerBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
limit | query | No | integer | — |
offset | query | No | integer | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Orders owned by the caller as customer or provider422Invalid pagination
POST/api/v1/ordersCreate an order as a member or guestOptional bearer; guest booking supported
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
Idempotency-Key | header | No | string | Required for guest requests; retry keys are supported for authenticated requests. |
JSON request body
Guest requests require email and phone. Client supplied totals, provider, and currency are ignored; the server derives them from the active menu item. Guest responses include a one-time capability; only its hash is stored.
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
menu_item_id | string | Yes | — | — |
quantity | integer | Yes | 1 to 100 | — |
schedule_at | string · date-time | No | — | — |
notes | string | No | — | — |
email | string · email | No | — | Required for guests |
phone | string | No | — | Required for guests |
Documented responses
201Order created; guest response includes a 90-day scoped access capability409Idempotency key reused with different data422Item unavailable or request invalid
GET/api/v1/guest/orders/{id}Recover a guest booking using its access capabilityGuest capability token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
X-Guest-Access-Token | header | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Guest order details404Booking not found
GET/api/v1/orders/{id}Read an order owned by the authenticated customer or providerBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Order details404Order not found or caller is not a participant
POST/api/v1/orders/{id}/transitionApply an authorized, versioned order state transitionBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
JSON request body
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
status | string | Yes | one of confirmed, in_progress, completed, cancelled | — |
version | integer | Yes | 1 to ∞ | — |
Documented responses
200Updated server order state403Caller is not allowed to make this transition404Order not found409Order version is stale422Transition is invalid for the current state
POST/api/v1/orders/{id}/paymentsCreate a payment attempt for an owned orderBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
Idempotency-Key | header | Yes | string | — |
JSON request body
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
method | string | Yes | one of wechat_qr, alipay_qr | — |
Documented responses
201Payment attempt created from the persisted order total; includes method-specific configured instructions409Idempotency key reused with different data422Order unavailable or not owned by caller
POST/api/v1/listings/{id}/subscription-paymentsCreate a listing subscription payment using the server-configured plan priceBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
Idempotency-Key | header | Yes | string | — |
JSON request body
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
method | string | Yes | one of wechat_qr, alipay_qr | — |
Documented responses
201Payment attempt created using the configured subscription amount and currency; includes method-specific configured instructions404Listing is not owned by caller409Idempotency key reused with different data422Subscription plan or request is unavailable
POST/api/v1/payments/{id}/submitSubmit a manual payment methodBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
JSON request body
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
method | string | Yes | one of wechat_qr, alipay_qr | — |
version | integer | Yes | 1 to ∞ | — |
Documented responses
200Payment submitted
POST/api/v1/payments/{id}/confirmConfirm a submitted paymentBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Payment confirmed403Provider or administrator required
POST/api/v1/payments/{id}/evidenceAttach payment evidenceBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Evidence submitted
Notifications
3 routesPOST/api/v1/devicesRegister a push notification deviceBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
201Device registered
GET/api/v1/notificationsList the authenticated user's notificationsBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Notifications returned
POST/api/v1/notifications/{id}/readMark a notification as readBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Notification acknowledged
Chat
6 routesGET/api/v1/chat/conversationsList conversations for the authenticated userBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Conversations returned
POST/api/v1/chat/conversationsCreate a chat conversationBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
201Conversation created
GET/api/v1/chat/conversations/{id}/messagesList messages in a conversationBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Messages returned
POST/api/v1/chat/conversations/{id}/messagesSend a conversation messageBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
201Message sent
POST/api/v1/chat/conversations/{id}/readMark conversation messages readBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Read state updated
GET/api/v1/chat/conversations/{id}/realtimeOpen the authenticated conversation WebSocketBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
101WebSocket upgraded
Media
2 routesPOST/api/v1/media/uploadRequest a signed media upload URLBearer token
JSON request body
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
purpose | string | Yes | — | — |
mime_type | string | Yes | one of image/jpeg, image/png, image/webp, video/mp4 | — |
size_bytes | integer | Yes | 1 to 10485760 | — |
Documented responses
201Upload URL created422Upload metadata is invalid
GET/api/v1/media/{id}Request an authorized signed media read URLBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Read URL created403Media access forbidden
Community
10 routesGET/api/v1/community/feedList community momentsBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Feed returned
POST/api/v1/community/momentsCreate a community momentBearer token
JSON request body
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
body | string | No | 0–2000 chars | — |
visibility | string | No | one of public | — |
media_asset_ids | array · string[] | No | — | — |
Documented responses
201Moment created
POST/api/v1/community/moments/{id}/likeLike a community momentBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Moment liked
POST/api/v1/community/moments/{id}/viewRecord a moment viewBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200View recorded
GET/api/v1/community/moments/{id}/countersRead server-calculated moment countersBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Counters returned
GET/api/v1/community/moments/{id}/commentsList comments on a momentBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
limit | query | No | integer | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Comments returned422Invalid limit
POST/api/v1/community/moments/{id}/commentsAdd a comment to a momentBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
201Comment created
POST/api/v1/community/moments/{id}/reportReport a momentBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
201Report submitted
POST/api/v1/community/users/{id}/blockBlock a userBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200User blocked
DELETE/api/v1/community/users/{id}/blockUnblock a userBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200User unblocked
Lifestyle
8 routesPUT/api/v1/dating/profileCreate or update the authenticated dating profileBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Profile saved
GET/api/v1/dating/browseBrowse opted-in visible dating profilesBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Profiles returned
GET/api/v1/curated-contentList published curated contentBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Content returned
GET/api/v1/meetingsList scheduled meetingsBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Meetings returned
POST/api/v1/meetingsSchedule a meetingBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
201Meeting created
POST/api/v1/meetings/{id}/joinJoin a scheduled or active meetingBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Participant joined with short-lived room-scoped LiveKit credentials404Meeting not found422Meeting has ended503Live video is not configured
POST/api/v1/meetings/{id}/leaveLeave a meetingBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Participant left404Active participation not found
POST/api/v1/meetings/{id}/endEnd a meeting as its hostBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Meeting ended403Only the host may end the meeting404Meeting not found
Administration and reporting
17 routesPOST/api/v1/admin/community/reports/{id}/moderateUpdate a community report statusBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Report updated403Administrator required
GET/api/v1/reports/summaryRead the scoped 30-day accountant/admin summaryBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Summary returned403Accountant or administrator required
GET/api/v1/admin/auditRead recent audit eventsBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Audit events returned403Administrator required
GET/api/v1/admin/overviewRead administrator operational totalsBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Marketplace and moderation totals returned403Administrator required
GET/api/v1/admin/{kind}Search an administrator collectionBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
kind | path | Yes | string | users, accountants, services, providers, listings, orders, payments |
q | query | No | string | — |
status | query | No | string | — |
limit | query | No | integer | — |
offset | query | No | integer | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Filtered collection and pagination returned403Administrator required
PATCH/api/v1/admin/{kind}/{id}/statusUpdate an administrator managed user or listing statusBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
kind | path | Yes | string | users, listings |
id | path | Yes | string | — |
JSON request body
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
status | string | Yes | — | — |
Documented responses
200Status changed and audited403Administrator required422Invalid status
POST/api/v1/admin/orders/{id}/transitionApply an authorized order workflow transition as an administratorBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
JSON request body
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
status | string | Yes | — | — |
version | integer | Yes | — | — |
Documented responses
200Order changed403Administrator required409Order changed concurrently
POST/api/v1/admin/payments/{id}/rejectReject a submitted payment and synchronize its order payment stateBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Payment rejected and decision audited403Administrator required409Payment is not awaiting review
GET/api/v1/admin/accountants/{id}/servicesRead services assigned to an accountantBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Service assignments returned403Administrator required
PUT/api/v1/admin/accountants/{id}/servicesReplace an accountant's assigned service scopeBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
JSON request body
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
service_ids | array · string[] | Yes | — | — |
Documented responses
200Assignments replaced and audited403Administrator required422Invalid accountant or service
PATCH/api/v1/admin/users/{id}/roleUpdate a user's roleBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
JSON request body
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
role | string | Yes | one of member, provider, accountant, admin | — |
Documented responses
200Role updated403Administrator required
GET/api/v1/admin/community/reportsList moderation reportsBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Reports returned
POST/api/v1/admin/community/reports/{id}/statusChange a report statusBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Report updated
POST/api/v1/admin/announcementsCreate an announcementBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
201Announcement created
GET/api/v1/announcementsList published announcementsBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Announcements returned
POST/api/v1/admin/providers/{id}/approveApprove a provider profile and record the decision in the audit logBearer token
Parameters
| Name | Location | Required | Type | Meaning |
|---|---|---|---|---|
id | path | Yes | string | — |
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200Provider approved403Administrator access required404Provider not found
GET/api/v1/admin/exports/reports.csvExport moderation reports as CSVBearer token
No JSON request schema in OpenAPI.This means the contract does not currently describe a JSON body for this operation. Where the handler accepts JSON, use the API SRS and Go handler as the detailed source.
Documented responses
200CSV export
Generated from API/openapi/openapi.yaml. Role and ownership rules are enforced by the Go handlers and services.