Server-to-server API for a brand to build its own admin frontend. Generated from
openapi.yaml by scripts/generate-api-reference.mjs on 2026-11-10 —
do not edit by hand.
x-api-key header
on every /api/v1 request. Keys are minted from the brand-admin key-management
endpoints (/api-keys), which use a brand-admin JWT (Authorization: Bearer …
from POST /auth/signin) — the only JWT-authenticated rows below. Keys default
to read-only; mutating endpoints require the write scope (403 INSUFFICIENT_SCOPE
otherwise). Publishable keys (fuse_pk_…) may call exactly one endpoint:
POST /api/v1/checkout/sessions. Every endpoint may return
429 Too Many Requests with a Retry-After header.
403 ENDPOINT_NOT_ENABLED — that per-clinic gate was removed on 2026-09-18. What
still applies: your key's scopes (read by default), the clinic your key belongs
to, your plan's entitlements for Affiliates (AFFILIATES_TIER_REQUIRED) and CRM
Connect (CRM_TIER_REQUIRED), and rate limits.
Auth & Key Management (5) · Orders (8) · Customers (1) · Programs (26) · Program Templates & Titration (5) · Products & Catalog (17) · Payouts & Refunds (5) · Billing (9) · Organization (13) · Onboarding (6) · Page Builder (9) · Refund Requests (2) · Treatments (8) · Dashboard & Analytics (11) · CRM · Contacts (5) · CRM · Tags (6) · CRM · Sequences (6) · CRM · Templates (6) · CRM · Connection (6) · Affiliate Program (20) · Team & Users (5) · Organization & Clinic (9) · Custom Website (8) · Support & Conversations (13) · Forms & Global Products (3) · Intake Requests (2) · Misc / Uploads (13) · Developer Sandbox (2) · Checkout Sessions (2) · Webhooks (3)
Key management uses a brand-admin JWT (from /auth/signin), NOT an API key. Everything else uses x-api-key.
| Method | Path | Summary |
|---|---|---|
| POST | /auth/signin |
Obtain a brand-admin JWT (to manage keys).
no auth
SchemasRequest body (application/json)
{
"email": "you@brand.com",
"password": "..."
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api-keys |
List this clinic's keys (metadata only — no secret).
JWT
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api-keys |
Issue a key. Default scope read-only + 1yr expiry; pass scopes:["write"]
for full. Raw key returned once.
JWT
SchemasRequest body (application/json)
{
"name": "My integration",
"kind": "secret",
"scopes": [
"read"
]
}
Response 201
{
"success": true,
"message": "string",
"data": null
}
|
| DELETE | /api-keys/{id} |
Revoke a key (immediate).
JWT
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/me |
Identify the key: clinic, name, scopes. Smoke-test connectivity.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/orders |
Paginated orders. Each row includes the per-order feeBreakdown.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/orders/stats |
Aggregate order + earnings stats.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/orders/summary |
Aggregate order breakdowns — by status, program, shipping state, and refunds (no
per-order rows).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": {
"window": {
"startDate": "string",
"endDate": "string"
},
"totalOrders": 0,
"byStatus": [
{
"status": "string",
"orders": 0
}
],
"byProgram": [
{
"programId": "string",
"programName": "string",
"orders": 0,
"paidSales": 0
}
],
"byState": [
{
"state": "string",
"orders": 0
}
],
"otherStates": {
"states": 0,
"orders": 0
},
"refunds": {
"byStatus": [
{
"status": "string",
"requests": 0
}
],
"approvedAmount": 0
}
}
}
|
| GET | /api/v1/orders/{id} |
Order detail with the full fee waterfall (matches the brand-admin UI).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"orderNumber": "string",
"status": "string",
"totalAmount": 0,
"subtotalAmount": 0,
"discountAmount": 0,
"taxAmount": 0,
"shippingAmount": 0,
"brandAmount": 0,
"billingInterval": "string",
"createdAt": "2026-01-01T00:00:00Z",
"shippedAt": "2026-01-01T00:00:00Z",
"deliveredAt": "2026-01-01T00:00:00Z",
"fulfillmentType": "string",
"approvedByDoctor": true,
"feeBreakdown": {},
"user": {
"id": "00000000-0000-0000-0000-000000000000",
"firstName": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string"
},
"orderItems": [
{
"id": "00000000-0000-0000-0000-000000000000",
"quantity": 0,
"unitPrice": 0,
"totalPrice": 0,
"product": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string"
}
}
],
"payment": {
"status": "string",
"paymentMethod": "string"
},
"shippingAddress": {
"address": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"country": "string"
},
"shippingOrders": [
{
"id": "00000000-0000-0000-0000-000000000000",
"status": "string",
"trackingNumber": "string",
"trackingUrl": "string"
}
]
}
}
|
| GET | /api/v1/orders/{id}/events |
Chronological status/event timeline for one order.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": {
"events": [
{
"id": "string",
"eventType": "string",
"actorType": "string",
"createdAt": "2026-01-01T00:00:00Z",
"metadata": {}
}
],
"hasPrescriptionPdf": true
}
}
|
| GET | /api/v1/orders/{id}/lab-status |
Lab lifecycle state and lab-kit tracking for one order.
key
SchemasResponse 200
{
"success": true,
"data": {
"orderId": "00000000-0000-0000-0000-000000000000",
"isLabGated": true,
"orderStatus": "string",
"stage": "requisition_created",
"timeline": [
{
"stage": "requisition_created",
"reached": true,
"occurredAt": "2026-01-01T00:00:00Z"
}
],
"kitShipmentToPatient": {
"carrier": "string",
"trackingNumber": "string",
"deliveredAt": "2026-01-01T00:00:00Z"
},
"kitShipmentToLab": {
"carrier": "string",
"trackingNumber": "string",
"receivedAt": "2026-01-01T00:00:00Z"
},
"resultsAvailableAt": "2026-01-01T00:00:00Z"
}
}
|
| GET | /api/v1/orders/{id}/visit-status |
Telehealth visit status and appointment time for one order.
key
SchemasResponse 200
{
"success": true,
"data": {
"orderId": "00000000-0000-0000-0000-000000000000",
"visitStatus": "not_booked",
"bookingRequired": true,
"scheduledAt": "2026-01-01T00:00:00Z",
"lastSyncedAt": "2026-01-01T00:00:00Z"
}
}
|
| GET | /api/v1/orders/needs-attention |
List orders needing attention (failed payment / dunning queue).
key
SchemasResponse 200
{
"success": true,
"data": {
"count": 0,
"items": [
{
"orderId": "00000000-0000-0000-0000-000000000000",
"orderNumber": "string",
"patientName": null,
"programName": null,
"paymentFailedAt": null,
"lastPaymentError": null,
"enrichment": {}
}
]
}
}
|
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/customers |
Patient directory with order count, revenue, tags.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"firstName": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"createdAt": "2026-01-01T00:00:00Z",
"orderCount": 0,
"totalRevenue": 0,
"categories": [
"string"
],
"hasActiveSubscription": true
}
]
}
|
The program surface. Every /:id path is scoped to the key's clinic (404 on anything it does not own).
| Method | Path | Summary |
|---|---|---|
| POST | /api/v1/programs/copilot/draft |
Draft a program with FUSE Copilot (AI).
key · write
SchemasRequest body (application/json)
{}
Response 200
{}
|
| GET | /api/v1/programs |
List the clinic's programs.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"isActive": true,
"isFeatured": true,
"nonMedicalServiceFee": 0,
"heroImageUrl": "string",
"customSlug": "string",
"accentColor": "string",
"sellableProductCount": 0,
"unpricedProductCount": 0,
"programGlobalProducts": [
{
"id": "00000000-0000-0000-0000-000000000000",
"displayOrder": 0,
"isPatientVisible": true,
"globalProduct": {
"packDurationMonths": 0,
"supplyDays": 0
}
}
]
}
]
}
|
| POST | /api/v1/programs |
Create a program.
key · write
SchemasRequest body (application/json)
{
"name": "New program"
}
Response 201
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"isActive": true,
"isFeatured": true,
"nonMedicalServiceFee": 0,
"heroImageUrl": "string",
"customSlug": "string",
"accentColor": "string",
"sellableProductCount": 0,
"unpricedProductCount": 0,
"programGlobalProducts": [
{
"id": "00000000-0000-0000-0000-000000000000",
"displayOrder": 0,
"isPatientVisible": true,
"globalProduct": {
"packDurationMonths": 0,
"supplyDays": 0
}
}
]
}
}
|
| GET | /api/v1/programs/overview |
Dashboard stats + attention items.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": {
"stats": {
"livePrograms": 0,
"draftPrograms": 0,
"pausedPrograms": 0,
"totalPatients": 0,
"estBilledMonthlyCents": 0,
"estNetMonthlyCents": 0
},
"perProgram": [
{
"programId": "00000000-0000-0000-0000-000000000000",
"patients": 0,
"estBilledMonthlyCents": 0,
"estNetMonthlyCents": 0
}
],
"attention": [
{
"type": "string",
"programId": "00000000-0000-0000-0000-000000000000",
"programName": "string",
"headline": "string",
"detail": "string",
"estValueCents": 0,
"action": "string"
}
]
}
}
|
| GET | /api/v1/programs/copilot/suggestions |
AI copilot suggestions for improving the clinic's programs.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/programs/{id} |
Program detail.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"isActive": true,
"isFeatured": true,
"nonMedicalServiceFee": 0,
"heroImageUrl": "string",
"customSlug": "string",
"accentColor": "string",
"sellableProductCount": 0,
"unpricedProductCount": 0,
"programGlobalProducts": [
{
"id": "00000000-0000-0000-0000-000000000000",
"displayOrder": 0,
"isPatientVisible": true,
"globalProduct": {
"packDurationMonths": 0,
"supplyDays": 0
}
}
]
}
}
|
| PUT | /api/v1/programs/{id} |
Update a program.
key · write
SchemasRequest body (application/json)
{
"name": "Renamed"
}
Response 200
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"isActive": true,
"isFeatured": true,
"nonMedicalServiceFee": 0,
"heroImageUrl": "string",
"customSlug": "string",
"accentColor": "string",
"sellableProductCount": 0,
"unpricedProductCount": 0,
"programGlobalProducts": [
{
"id": "00000000-0000-0000-0000-000000000000",
"displayOrder": 0,
"isPatientVisible": true,
"globalProduct": {
"packDurationMonths": 0,
"supplyDays": 0
}
}
]
}
}
|
| DELETE | /api/v1/programs/{id} |
Delete one of the clinic's programs.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"isActive": true,
"isFeatured": true,
"nonMedicalServiceFee": 0,
"heroImageUrl": "string",
"customSlug": "string",
"accentColor": "string",
"sellableProductCount": 0,
"unpricedProductCount": 0,
"programGlobalProducts": [
{
"id": "00000000-0000-0000-0000-000000000000",
"displayOrder": 0,
"isPatientVisible": true,
"globalProduct": {
"packDurationMonths": 0,
"supplyDays": 0
}
}
]
}
}
|
| GET | /api/v1/programs/{id}/global-products |
Fee-adjusted product pool for a program.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/programs/{id}/duplicate |
Clone a program (deep copy of its product config).
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/programs/{id}/hero-image |
Set a program's picture from an image URL.
key · write
SchemasRequest body (application/json)
{
"imageUrl": "string"
}
Response 200
{
"success": true,
"message": "string",
"data": {
"id": "string",
"heroImageUrl": "string",
"clinicProgramId": "string"
}
}
|
| GET | /api/v1/programs/{id}/products |
Effective per-product patient pricing for a program.
key
SchemasResponse 200
{
"success": true,
"data": {
"programId": "00000000-0000-0000-0000-000000000000",
"nonMedicalServiceFee": 0,
"nonMedicalServiceFeeIncludedInDisplayPrice": true,
"products": [
{
"globalProductId": "00000000-0000-0000-0000-000000000000",
"name": "string",
"displayOrder": 0,
"linkSource": "program",
"isPatientVisible": true,
"displayPrice": 0,
"effectiveProgramFee": 0,
"feeSource": "clinic_override",
"levelPrices": {
"macrodose": [
{
"level": 1,
"price": 210
},
{
"level": 2,
"price": 230
}
],
"microdose": [
{
"level": 1,
"price": 150
}
]
},
"clinicProgramFee": 0,
"programBaseFee": 0,
"placeholderPrice": 0,
"pharmacyBasePrice": 0,
"packDurationMonths": 0,
"vialsPerPack": 0,
"supplyDays": 0,
"allowPrepay": true,
"isSellable": true,
"isCostBacked": true,
"hasResolvedPrice": true
}
]
}
}
|
| PUT | /api/v1/programs/{id}/products |
Replace the program's product set.
key · write
SchemasRequest body (application/json)
{
"products": [
{
"productId": "<global-product-uuid>"
}
]
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/programs/{id}/quote |
Exact checkout quote for one product of a program (no order created).
key
SchemasResponse 200
{
"success": true,
"data": {
"programId": "string",
"productId": "string",
"state": "string",
"months": 0,
"isPrepay": true,
"customerPays": 0,
"subtotal": 0,
"programFee": 0,
"fees": {
"stripeFee": 0,
"doctorFee": 0,
"productCosts": 0,
"fuseMerchantServiceFee": 0
},
"rollingReserve": 0,
"brandMarginBeforeCoupon": 0,
"brandMargin": 0,
"coupon": {
"code": "string",
"outcome": "applied",
"discount": 0,
"brandAbsorbed": 0,
"policy": "string",
"reason": "string",
"message": "string"
},
"notes": [
"string"
]
}
}
|
| POST | /api/v1/programs/{id}/upload-image |
Upload a program cover image (multipart, field `image`).
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/programs/sync-all |
Re-sync ALL of the clinic's template-derived programs against their source
templates.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"isActive": true,
"isFeatured": true,
"nonMedicalServiceFee": 0,
"heroImageUrl": "string",
"customSlug": "string",
"accentColor": "string",
"sellableProductCount": 0,
"unpricedProductCount": 0,
"programGlobalProducts": [
{
"id": "00000000-0000-0000-0000-000000000000",
"displayOrder": 0,
"isPatientVisible": true,
"globalProduct": {
"packDurationMonths": 0,
"supplyDays": 0
}
}
]
}
}
|
| POST | /api/v1/programs/{id}/sync |
Re-sync one derived program against its source template.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/programs/{id}/sync-status |
Whether a derived program is behind its source template.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/programs/{id}/products/activation-status |
Per-product activation state within a program.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/programs/{id}/products/visibility-status |
Per-product patient-visibility state within a program.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| PATCH | /api/v1/programs/{id}/products/{productId}/activate |
Activate/deactivate a product in the program.
key · write
SchemasRequest body (application/json)
{
"isActive": true
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| PATCH | /api/v1/programs/{id}/products/{productId}/visibility |
Toggle a product's patient visibility.
key · write
SchemasRequest body (application/json)
{
"isPatientVisible": true
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/programs/{id}/titration-protocols |
Titration protocols attached to a program.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/programs/{id}/titration-protocols |
Attach a titration protocol to a program.
key · write
SchemasRequest body (application/json)
{
"titrationProtocolId": "<protocol-uuid>",
"flatFee": 0,
"allowedBillingMonths": [
1,
3
],
"position": 0
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| PUT | /api/v1/programs/{id}/titration-protocols/{attachmentId} |
Update a program's titration-protocol attachment.
key · write
SchemasRequest body (application/json)
{
"flatFee": 25,
"allowedBillingMonths": [
1,
3,
6
],
"position": 1
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| DELETE | /api/v1/programs/{id}/titration-protocols/{attachmentId} |
Detach a titration protocol from a program.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
Shared FUSE catalogues (global by design — same posture as GET /config/fees). No clinic filter, no PHI.
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/titration-schedule/fulfillment-held |
List titration schedules held for fulfillment (awaiting revisit).
key
SchemasResponse 200
{
"success": true,
"data": [
{
"id": "string",
"currentLevel": 0,
"maxLevel": 0,
"status": "string",
"nextRevisitDueAt": "2026-01-01T00:00:00Z",
"lastRevisitAt": "2026-01-01T00:00:00Z",
"heldSince": "2026-01-01T00:00:00Z",
"daysOverdue": 0,
"order": {
"id": "string",
"orderNumber": "string",
"status": "string"
},
"user": {
"id": "string",
"firstName": "string",
"lastName": "string"
},
"program": {
"id": "string",
"name": "string"
},
"titrationProtocol": {
"id": "string",
"name": "string",
"maxLevel": 0
}
}
],
"pagination": {
"page": 0,
"limit": 0,
"total": 0,
"totalPages": 0
}
}
|
| GET | /api/v1/program-templates |
List the shared FUSE program templates.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null,
"pagination": {
"page": 0,
"limit": 0,
"total": 0,
"totalPages": 0
}
}
|
| GET | /api/v1/program-templates/{id} |
One program template.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/program-templates/{id}/global-products |
Global products carried by a program template.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/titration-protocols |
List the shared FUSE titration protocols.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| Method | Path | Summary |
|---|---|---|
| POST | /api/v1/products/{id}/upload-image |
Upload or remove a product's image.
key · write
SchemasRequest body (application/json)
{
"removeImage": true
}
Response 200
{}
|
| GET | /api/v1/public/products/{productId}/pharmacy-coverages |
List a product's pharmacy coverages (clinic-scoped).
key
SchemasResponse 200
{
"success": true,
"data": [
{}
]
}
|
| GET | /api/v1/catalog |
Storefront catalog (light view) — same source as the brand portal.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"slug": "string",
"categories": [
"string"
],
"imageUrl": "string",
"description": "string",
"requiresCooler": true,
"pharmacyPrice": 0,
"facilitationFee": 0,
"price": 0,
"pharmacyName": "string",
"pharmacyRole": "primary",
"programs": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string"
}
]
}
]
}
|
| GET | /api/v1/products |
Product management view (clinic's own + shared platform products).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"slug": "string",
"description": "string",
"category": "string",
"categories": [
"string"
],
"isActive": true,
"pharmacyProvider": "string",
"pharmacyPrice": 0,
"pharmacyProductId": "string",
"brandName": "string",
"imageUrl": "string",
"pharmacyCoverages": [
{
"id": "string",
"customName": "string",
"pharmacy": {
"id": "string",
"name": "string",
"slug": "string"
}
}
]
}
]
}
|
| POST | /api/v1/products |
Create a custom product for the key clinic's brand.
key · write
SchemasRequest body (application/json)
{
"name": "string",
"description": "string",
"pharmacyPrice": 0,
"pharmacyProductId": "string",
"isActive": true
}
Response 201
{}
|
| GET | /api/v1/products/{id} |
One product (accepts a Product id or a GlobalProduct id).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"slug": "string",
"description": "string",
"category": "string",
"categories": [
"string"
],
"isActive": true,
"pharmacyProvider": "string",
"pharmacyPrice": 0,
"pharmacyProductId": "string",
"brandName": "string",
"imageUrl": "string",
"pharmacyCoverages": [
{
"id": "string",
"customName": "string",
"pharmacy": {
"id": "string",
"name": "string",
"slug": "string"
}
}
]
}
}
|
| PUT | /api/v1/products/{id} |
Update one of the clinic's OWN products.
key · write
SchemasRequest body (application/json)
{
"description": "Updated copy"
}
Response 200
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"slug": "string",
"description": "string",
"category": "string",
"categories": [
"string"
],
"isActive": true,
"pharmacyProvider": "string",
"pharmacyPrice": 0,
"pharmacyProductId": "string",
"brandName": "string",
"imageUrl": "string",
"pharmacyCoverages": [
{
"id": "string",
"customName": "string",
"pharmacy": {
"id": "string",
"name": "string",
"slug": "string"
}
}
]
}
}
|
| GET | /api/v1/brand/product-catalog |
Alias of /catalog — the brand's fee-adjusted product catalog.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"slug": "string",
"categories": [
"string"
],
"imageUrl": "string",
"description": "string",
"requiresCooler": true,
"pharmacyPrice": 0,
"facilitationFee": 0,
"price": 0,
"pharmacyName": "string",
"pharmacyRole": "primary",
"programs": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string"
}
]
}
]
}
|
| GET | /api/v1/products-management/{id} |
Alias of GET /products/:id — read one of the clinic's own products.
key
SchemasResponse 200
{
"success": true,
"data": {}
}
|
| PUT | /api/v1/products-management/{id} |
Alias of PUT /products/:id — update one of the clinic's own products.
key · write
SchemasRequest body (application/json)
{
"description": "Updated copy"
}
Response 200
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"slug": "string",
"description": "string",
"category": "string",
"categories": [
"string"
],
"isActive": true,
"pharmacyProvider": "string",
"pharmacyPrice": 0,
"pharmacyProductId": "string",
"brandName": "string",
"imageUrl": "string",
"pharmacyCoverages": [
{
"id": "string",
"customName": "string",
"pharmacy": {
"id": "string",
"name": "string",
"slug": "string"
}
}
]
}
}
|
| GET | /api/v1/tenant-products |
The clinic's own tenant-product offerings + facilitation fees.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/global-products/discontinued-in-use |
Discontinued global SKUs still referenced by THIS clinic's programs.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/tenant-products/update |
Set the price of one tenant product (creates a real Stripe price).
key · write
SchemasRequest body (application/json)
{
"tenantProductId": "<tenant-product-uuid>",
"price": 99
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/tenant-products/update-selection |
Update the clinic's selected tenant products (enforces plan limits + billing caps).
key · write
SchemasRequest body (application/json)
{
"products": [
{
"productId": "<product-uuid>",
"questionnaireId": "<questionnaire-uuid>"
}
]
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/global-products/{id}/upload-image |
Upload a brand-scoped image override for a global product (multipart, field `image`;
never mutates the shared product).
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/global-form-structures |
Shared FUSE global form-builder structure catalog (no clinic data / no PHI).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/products-management |
List the brand's products (product-management view).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": {
"products": [
{}
],
"pagination": {
"page": 0,
"limit": 0,
"total": 0,
"totalPages": 0
}
}
}
|
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/payouts |
Order-level payout history.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "string",
"orderId": "00000000-0000-0000-0000-000000000000",
"orderNumber": "string",
"amount": 0,
"totalAmount": 0,
"date": "2026-01-01T00:00:00Z",
"status": "string",
"stripeTransferId": "string",
"customer": {
"name": "string",
"email": "string"
}
}
]
}
|
| GET | /api/v1/payouts/balance |
Balance, reserve, held, Stripe — the portal's exact numbers.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": {
"balance": {
"totalReceived": 0,
"totalWithdrawn": 0,
"currentBalance": 0,
"lastUpdated": "2026-01-01T00:00:00Z"
},
"stripeBalance": {
"available": 0,
"pending": 0
},
"withdrawable": 0,
"reserve": {
"totalHeld": 0,
"totalReleased": 0,
"totalForfeited": 0,
"heldCount": 0
},
"heldBalance": {
"heldOwed": 0,
"hasHeldBalance": true,
"isConnected": true
},
"recentActivity": [
{}
]
}
}
|
| GET | /api/v1/payouts/disputes |
Dispute summary + history.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/payouts/withdraw |
Withdraw available balance to the connected Stripe account.
key · write
SchemasRequest body (application/json)
{
"amount": 100
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/refunds |
Full refund on one of the clinic's own orders (30-day + balance guard).
key · write
SchemasRequest body (application/json)
{
"orderId": "<order-uuid>",
"reason": "customer request"
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/stripe/connect/status |
Stripe Connect account status.
key
SchemasResponse 200
{}
|
| GET | /api/v1/billing/validate-coupon |
Validate a subscription coupon code.
key
SchemasResponse 200
{
"success": true,
"data": {}
}
|
| GET | /api/v1/billing/plans |
List active brand subscription plans.
key
SchemasResponse 200
{
"success": true,
"plans": [
{}
]
}
|
| GET | /api/v1/billing/current |
Current subscription (stub, always null).
key
SchemasResponse 200
{
"success": true,
"subscription": {}
}
|
| GET | /api/v1/billing/basic-info |
Basic subscription info for the key's clinic.
key
SchemasResponse 200
{
"success": true,
"data": {}
}
|
| POST | /api/v1/billing/preview-upgrade |
Preview proration for a plan change.
key · write
SchemasRequest body (application/json)
{
"newPlanId": "string"
}
Response 200
{}
|
| POST | /api/v1/billing/cancel |
Give 60 days' notice of cancellation.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": {
"cancelsAt": "2026-01-01T00:00:00Z",
"cancellationRequestedAt": "2026-01-01T00:00:00Z",
"noticeDays": 0
}
}
|
| POST | /api/v1/billing/cancel/withdraw |
Withdraw a cancellation notice before it runs out.
key · write
SchemasResponse 200
{}
|
| POST | /api/v1/billing/change |
Change the clinic's subscription plan.
key · write
SchemasRequest body (application/json)
{
"newPlanId": "string"
}
Response 200
{}
|
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/organization/sms/twilio |
Get the clinic's Twilio SMS config.
key
SchemasResponse 200
{}
|
| PUT | /api/v1/organization/sms/twilio |
Set the clinic's Twilio SMS config.
key · write
SchemasRequest body (application/json)
{
"accountSid": "string",
"authToken": "string",
"phoneNumber": "string"
}
Response 200
{}
|
| DELETE | /api/v1/organization/sms/twilio |
Remove the clinic's Twilio SMS config.
key · write
SchemasResponse 200
{}
|
| GET | /api/v1/organization/sms/status |
SMS provisioning status (AWS Pinpoint).
key
SchemasResponse 200
{}
|
| POST | /api/v1/organization/sms/activate |
Provision a toll-free SMS number (AWS Pinpoint).
key · write
SchemasResponse 200
{}
|
| DELETE | /api/v1/organization/sms/release |
Release the clinic's toll-free SMS number.
key · write
SchemasResponse 200
{}
|
| POST | /api/v1/clinic/custom-domain/start |
Begin custom-domain setup (ACM cert request).
key · write
SchemasRequest body (application/json)
{
"domain": "string"
}
Response 200
{}
|
| POST | /api/v1/clinic/custom-domain/verify |
Verify custom-domain DNS/ACM validation.
key · write
SchemasResponse 200
{}
|
| POST | /api/v1/clinic/custom-domain/finalize |
Finalize custom-domain (attach to ALB).
key · write
SchemasResponse 200
{}
|
| POST | /api/v1/clinic/custom-domain/remove |
Remove the clinic's custom domain.
key · write
SchemasResponse 200
{}
|
| PUT | /api/v1/organization/update |
Update organization/clinic profile.
key · write
SchemasRequest body (application/json)
{}
Response 200
{}
|
| PUT | /api/v1/clinic/{id} |
Update the key's clinic (clinic-scoped).
key · write
SchemasRequest body (application/json)
{}
Response 200
{}
|
| GET | /api/v1/clinic/check-slug/{slug} |
Check clinic-slug availability.
key
SchemasResponse 200
{
"success": true,
"available": true
}
|
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/onboarding/status |
Onboarding status for the key's clinic.
key
SchemasResponse 200
{
"success": true,
"data": {}
}
|
| POST | /api/v1/onboarding/request-name-change |
One-time brand-owner name change.
key · write
SchemasRequest body (application/json)
{
"firstName": "string",
"lastName": "string"
}
Response 200
{}
|
| POST | /api/v1/onboarding/confirm-signature-declaration |
Confirm the electronic-signature declaration.
key · write
SchemasRequest body (application/json)
{
"typedName": "string"
}
Response 200
{}
|
| POST | /api/v1/onboarding/save-business-details |
Save brand business details.
key · write
SchemasRequest body (application/json)
{
"ein": "string",
"stateOfRegistration": "string",
"address": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"phoneNumber": "string",
"businessType": "string",
"companyName": "string"
}
Response 200
{}
|
| GET | /api/v1/build-readiness |
What this brand still needs before it can sell.
key
SchemasResponse 200
{
"success": true,
"data": {
"mode": "sandbox",
"readyToSell": true,
"complete": true,
"summary": {
"done": 0,
"todo": 0,
"blocked": 0,
"optional": 0,
"portal": 0,
"waitingOnFuse": 0
},
"sections": [
{
"id": "string",
"label": "string",
"items": [
{
"id": "string",
"status": "done",
"headline": "string",
"detail": "string",
"fixWith": {
"tool": null,
"args": null,
"portal": null,
"when": null
},
"blockers": [
null
],
"guide": "string"
}
]
}
],
"nextBest": [
{
"id": "string",
"status": "done",
"headline": "string",
"detail": "string",
"fixWith": {
"tool": "string",
"args": {},
"portal": "string",
"when": "now"
},
"blockers": [
{
"code": "string",
"message": "string"
}
],
"guide": "string"
}
]
}
}
|
| GET | /api/v1/help/walkthroughs |
The brand walkthrough videos, and the moment that shows how.
key
SchemasResponse 200
{
"success": true,
"data": {
"covered": true,
"moments": [
{
"video": "string",
"videoTitle": "string",
"seconds": 0,
"at": "string",
"chapter": {
"number": 0,
"title": "string",
"portal": "brand"
},
"tab": "string",
"step": "string",
"label": "string",
"watchUrl": "string",
"pageUrl": "string",
"says": "string"
}
],
"browseUrl": "string"
}
}
|
| Method | Path | Summary |
|---|---|---|
| POST | /api/v1/page-builder/upload-image |
Upload a page-builder image.
key · write
SchemasResponse 200
{}
|
| GET | /api/v1/page-builder/pages |
List the key clinic's pages.
key
SchemasResponse 200
{
"success": true,
"data": [
{}
]
}
|
| POST | /api/v1/page-builder/pages |
Create a new draft page.
key · write
SchemasRequest body (application/json)
{
"slug": "string",
"pageType": "string",
"isHomepage": true,
"draftContent": {},
"seoTitle": "string",
"seoDescription": "string"
}
Response 201
{}
|
| GET | /api/v1/page-builder/pages/{id} |
Fetch one page (clinic-scoped).
key
SchemasResponse 200
{}
|
| PUT | /api/v1/page-builder/pages/{id} |
Save page draft (autosave).
key · write
SchemasRequest body (application/json)
{
"slug": "string",
"draftContent": {},
"isHomepage": true,
"seoTitle": "string",
"seoDescription": "string",
"seoOgImage": "string",
"seoCanonical": "string"
}
Response 200
{}
|
| DELETE | /api/v1/page-builder/pages/{id} |
Soft-delete a page.
key · write
SchemasResponse 200
{}
|
| POST | /api/v1/page-builder/pages/{id}/publish |
Publish a page (promote draft to published).
key · write
SchemasResponse 200
{}
|
| GET | /api/v1/page-builder/navigation |
Get the clinic's header/footer menus.
key
SchemasResponse 200
{}
|
| PUT | /api/v1/page-builder/navigation |
Upsert the clinic's navigation menus.
key · write
SchemasRequest body (application/json)
{
"headerMenu": [
{}
],
"footerMenu": [
{}
]
}
Response 200
{}
|
Incoming patient-initiated refund-request triage. Approving a request moves real money.
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/refund-requests |
List incoming patient refund requests for the clinic.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/refund-requests/{id}/{action} |
Approve or deny a refund request (:action = approve|deny). Approve issues the
refund.
key · write
SchemasRequest body (application/json)
{
"reviewNotes": "Approved per policy"
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
Legacy treatment surface (programs are the modern surface).
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/treatments |
Clinic treatments.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"slug": "string",
"selected": true,
"brandColor": "string",
"brandLogo": "string",
"clinicSlug": "string",
"productsPrice": 0
}
]
}
|
| POST | /api/v1/treatments |
Create a treatment.
key · write
SchemasRequest body (application/json)
{
"name": "New treatment",
"description": "..."
}
Response 201
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"slug": "string",
"selected": true,
"brandColor": "string",
"brandLogo": "string",
"clinicSlug": "string",
"productsPrice": 0
}
}
|
| GET | /api/v1/treatments/{id} |
One treatment (clinic-scoped by id + clinicId).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"slug": "string",
"selected": true,
"brandColor": "string",
"brandLogo": "string",
"clinicSlug": "string",
"productsPrice": 0
}
}
|
| PUT | /api/v1/treatments/{id} |
Update one of the clinic's own treatments.
key · write
SchemasRequest body (application/json)
{
"name": "Renamed treatment"
}
Response 200
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"slug": "string",
"selected": true,
"brandColor": "string",
"brandLogo": "string",
"clinicSlug": "string",
"productsPrice": 0
}
}
|
| GET | /api/v1/brand-treatments |
Global treatments joined with this brand's selections.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"treatmentLogo": "string",
"active": true,
"selected": true,
"brandLogo": "string",
"brandColor": "string",
"clinicSlug": "string"
}
]
}
|
| POST | /api/v1/brand-treatments |
Select a global treatment for the brand.
key · write
SchemasRequest body (application/json)
{
"treatmentId": "<treatment-uuid>"
}
Response 201
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"treatmentLogo": "string",
"active": true,
"selected": true,
"brandLogo": "string",
"brandColor": "string",
"clinicSlug": "string"
}
}
|
| DELETE | /api/v1/brand-treatments |
Deselect a global treatment for the brand.
key · write
SchemasRequest body (application/json)
{
"treatmentId": "<treatment-uuid>"
}
Response 200
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"treatmentLogo": "string",
"active": true,
"selected": true,
"brandLogo": "string",
"brandColor": "string",
"clinicSlug": "string"
}
}
|
| POST | /api/v1/treatment/{id}/upload-logo |
Upload/remove a treatment logo (multipart, field `logo`; send removeLogo=true to
clear).
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
Clinic-level aggregates only (recent-activity is HIPAA-scrubbed). Reads take clinicId from the key, never the query.
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/dashboard/overview |
Top-line dashboard summary.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/dashboard/metrics |
Key metric tiles (orders, revenue, patients).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/dashboard/earnings-report |
Earnings breakdown report.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/dashboard/recent-activity |
Recent clinic activity feed (PHI-scrubbed).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/dashboard/revenue-chart |
Time-series revenue chart data.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/dashboard/projected-revenue |
Projected revenue from active subscriptions.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/analytics/forms |
The clinic's own intake-form metrics (no PHI).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/likes/admin/analytics/{tenantProductId} |
Like/engagement analytics for one of the clinic's tenant products.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/likes/admin/counts |
Bulk like counts for a list of tenant products (POST only because ids travel in the
body; mutates nothing).
key · write
SchemasRequest body (application/json)
{
"tenantProductIds": [
"<tenant-product-uuid>"
]
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/analytics/forms/{formId}/sessions |
Per-form intake funnel sessions.
key
SchemasResponse 200
{
"success": true,
"data": {}
}
|
| GET | /api/v1/analytics/programs/{questionnaireId}/sessions |
Per-program intake funnel sessions.
key
SchemasResponse 200
{
"success": true,
"data": {}
}
|
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/contacts |
List contacts (patients).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"firstName": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"emailOptedOut": true,
"smsOptedOut": true,
"notifyProductNews": true,
"notifySmsUpdates": true,
"optOutDate": "2026-01-01T00:00:00Z",
"createdAt": "2026-01-01T00:00:00Z",
"lastLoginAt": "2026-01-01T00:00:00Z",
"lastContactDate": "2026-01-01T00:00:00Z",
"tags": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"category": "string",
"color": "string",
"clinicId": "00000000-0000-0000-0000-000000000000",
"isActive": true,
"createdAt": "2026-01-01T00:00:00Z",
"updatedAt": "2026-01-01T00:00:00Z"
}
]
}
]
}
|
| POST | /api/v1/contacts |
Create a contact (provisions a patient + welcome email).
key · write
SchemasRequest body (application/json)
{
"firstName": "Jane",
"lastName": "Doe",
"email": "jane@example.com"
}
Response 201
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"firstName": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"emailOptedOut": true,
"smsOptedOut": true,
"notifyProductNews": true,
"notifySmsUpdates": true,
"optOutDate": "2026-01-01T00:00:00Z",
"createdAt": "2026-01-01T00:00:00Z",
"lastLoginAt": "2026-01-01T00:00:00Z",
"lastContactDate": "2026-01-01T00:00:00Z",
"tags": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"category": "string",
"color": "string",
"clinicId": "00000000-0000-0000-0000-000000000000",
"isActive": true,
"createdAt": "2026-01-01T00:00:00Z",
"updatedAt": "2026-01-01T00:00:00Z"
}
]
}
}
|
| PUT | /api/v1/contacts/{id} |
Update a contact.
key · write
SchemasRequest body (application/json)
{
"firstName": "Jane"
}
Response 200
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"firstName": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"emailOptedOut": true,
"smsOptedOut": true,
"notifyProductNews": true,
"notifySmsUpdates": true,
"optOutDate": "2026-01-01T00:00:00Z",
"createdAt": "2026-01-01T00:00:00Z",
"lastLoginAt": "2026-01-01T00:00:00Z",
"lastContactDate": "2026-01-01T00:00:00Z",
"tags": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"category": "string",
"color": "string",
"clinicId": "00000000-0000-0000-0000-000000000000",
"isActive": true,
"createdAt": "2026-01-01T00:00:00Z",
"updatedAt": "2026-01-01T00:00:00Z"
}
]
}
}
|
| PUT | /api/v1/contacts/{id}/marketing-consent |
Record or withdraw a contact's consent to marketing email.
key · write
SchemasRequest body (application/json)
{
"consented": true,
"attestation": true,
"consentSource": "web_form",
"consentObtainedAt": "2026-10-01"
}
Response 200
{
"success": true,
"message": "string",
"data": {
"id": "string",
"notifyProductNews": true
}
}
|
| POST | /api/v1/contacts/import |
Bulk CSV import (multipart, field `csv`, 5 MB). Headers:
firstname,lastname,email[,phonenumber]. Patient emails are redacted from error rows.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"firstName": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"emailOptedOut": true,
"smsOptedOut": true,
"notifyProductNews": true,
"notifySmsUpdates": true,
"optOutDate": "2026-01-01T00:00:00Z",
"createdAt": "2026-01-01T00:00:00Z",
"lastLoginAt": "2026-01-01T00:00:00Z",
"lastContactDate": "2026-01-01T00:00:00Z",
"tags": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"category": "string",
"color": "string",
"clinicId": "00000000-0000-0000-0000-000000000000",
"isActive": true,
"createdAt": "2026-01-01T00:00:00Z",
"updatedAt": "2026-01-01T00:00:00Z"
}
]
}
}
|
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/tags |
List tags (category/isActive filters).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"category": "string",
"color": "string",
"clinicId": "00000000-0000-0000-0000-000000000000",
"isActive": true,
"createdAt": "2026-01-01T00:00:00Z",
"updatedAt": "2026-01-01T00:00:00Z"
}
]
}
|
| POST | /api/v1/tags |
Create a tag.
key · write
SchemasRequest body (application/json)
{
"name": "VIP",
"color": "#3B82F6"
}
Response 201
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"category": "string",
"color": "string",
"clinicId": "00000000-0000-0000-0000-000000000000",
"isActive": true,
"createdAt": "2026-01-01T00:00:00Z",
"updatedAt": "2026-01-01T00:00:00Z"
}
}
|
| PUT | /api/v1/tags/{id} |
Update a tag.
key · write
SchemasRequest body (application/json)
{
"color": "#123456"
}
Response 200
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"category": "string",
"color": "string",
"clinicId": "00000000-0000-0000-0000-000000000000",
"isActive": true,
"createdAt": "2026-01-01T00:00:00Z",
"updatedAt": "2026-01-01T00:00:00Z"
}
}
|
| DELETE | /api/v1/tags/{id} |
Delete a tag (cascades assignments).
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"category": "string",
"color": "string",
"clinicId": "00000000-0000-0000-0000-000000000000",
"isActive": true,
"createdAt": "2026-01-01T00:00:00Z",
"updatedAt": "2026-01-01T00:00:00Z"
}
}
|
| POST | /api/v1/tags/{id}/assign |
Assign a tag to a patient.
key · write
SchemasRequest body (application/json)
{
"userId": "<patient-uuid>"
}
Response 201
{
"success": true,
"message": "string",
"data": null
}
|
| DELETE | /api/v1/tags/{id}/assign/{userId} |
Unassign a tag.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/sequences |
List sequences.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"clinicId": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"status": "draft",
"trigger": {},
"steps": [
{
"id": "string",
"type": "delay",
"timeSeconds": 0,
"useCustomText": true,
"templateId": "00000000-0000-0000-0000-000000000000",
"customText": "string",
"customSubject": "string"
}
],
"analytics": {},
"isActive": true,
"createdAt": "2026-01-01T00:00:00Z",
"updatedAt": "2026-01-01T00:00:00Z"
}
]
}
|
| POST | /api/v1/sequences |
Create a sequence (draft). Key-created rows store createdBy=null (audited).
key · write
SchemasRequest body (application/json)
{
"name": "Welcome series",
"triggerEvent": "manual"
}
Response 201
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"clinicId": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"status": "draft",
"trigger": {},
"steps": [
{
"id": "string",
"type": "delay",
"timeSeconds": 0,
"useCustomText": true,
"templateId": "00000000-0000-0000-0000-000000000000",
"customText": "string",
"customSubject": "string"
}
],
"analytics": {},
"isActive": true,
"createdAt": "2026-01-01T00:00:00Z",
"updatedAt": "2026-01-01T00:00:00Z"
}
}
|
| GET | /api/v1/sequences/{id} |
Sequence detail + analytics.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"clinicId": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"status": "draft",
"trigger": {},
"steps": [
{
"id": "string",
"type": "delay",
"timeSeconds": 0,
"useCustomText": true,
"templateId": "00000000-0000-0000-0000-000000000000",
"customText": "string",
"customSubject": "string"
}
],
"analytics": {},
"isActive": true,
"createdAt": "2026-01-01T00:00:00Z",
"updatedAt": "2026-01-01T00:00:00Z"
}
}
|
| PUT | /api/v1/sequences/{id} |
Update a sequence.
key · write
SchemasRequest body (application/json)
{
"name": "Renamed"
}
Response 200
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"clinicId": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"status": "draft",
"trigger": {},
"steps": [
{
"id": "string",
"type": "delay",
"timeSeconds": 0,
"useCustomText": true,
"templateId": "00000000-0000-0000-0000-000000000000",
"customText": "string",
"customSubject": "string"
}
],
"analytics": {},
"isActive": true,
"createdAt": "2026-01-01T00:00:00Z",
"updatedAt": "2026-01-01T00:00:00Z"
}
}
|
| PUT | /api/v1/sequences/{id}/steps |
Replace a sequence's steps.
key · write
SchemasRequest body (application/json)
{
"steps": []
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/sequence-triggers/manual |
Manually trigger an active sequence for a user or a tag (provide exactly one).
key · write
SchemasRequest body (application/json)
{
"sequenceId": "<seq-uuid>",
"userId": "<patient-uuid>"
}
Response 201
{
"success": true,
"message": "string",
"data": {
"sequenceId": "string",
"sequenceRunId": "string",
"sequenceRunIds": [
"string"
],
"usersTriggered": 0,
"usersSkipped": 0,
"skippedChannels": [
"no_email"
],
"skipped": [
{
"userId": "string",
"reasons": [
"no_email"
]
}
],
"partiallySkipped": [
{
"userId": "string",
"reasons": [
"no_email"
]
}
]
}
}
|
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/message-templates |
List message templates.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"clinicId": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"type": "email",
"subject": "string",
"body": "string",
"category": "string",
"mergeFields": [
"string"
],
"isActive": true,
"version": 0,
"createdAt": "2026-01-01T00:00:00Z"
}
]
}
|
| POST | /api/v1/message-templates |
Create a template. Key-created rows store createdBy=null (audited).
key · write
SchemasRequest body (application/json)
{
"name": "Welcome email",
"type": "email",
"subject": "Welcome",
"body": "Hi {{firstName}}"
}
Response 201
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"clinicId": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"type": "email",
"subject": "string",
"body": "string",
"category": "string",
"mergeFields": [
"string"
],
"isActive": true,
"version": 0,
"createdAt": "2026-01-01T00:00:00Z"
}
}
|
| PUT | /api/v1/message-templates/{id} |
Update a template.
key · write
SchemasRequest body (application/json)
{
"body": "Hi {{firstName}}"
}
Response 200
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"clinicId": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"type": "email",
"subject": "string",
"body": "string",
"category": "string",
"mergeFields": [
"string"
],
"isActive": true,
"version": 0,
"createdAt": "2026-01-01T00:00:00Z"
}
}
|
| DELETE | /api/v1/message-templates/{id} |
Delete a template (soft).
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"clinicId": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"type": "email",
"subject": "string",
"body": "string",
"category": "string",
"mergeFields": [
"string"
],
"isActive": true,
"version": 0,
"createdAt": "2026-01-01T00:00:00Z"
}
}
|
| POST | /api/v1/message-templates/upload-image |
Upload an image for use in a template (multipart, field `image`).
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"clinicId": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"type": "email",
"subject": "string",
"body": "string",
"category": "string",
"mergeFields": [
"string"
],
"isActive": true,
"version": 0,
"createdAt": "2026-01-01T00:00:00Z"
}
}
|
| POST | /api/v1/message-templates/{id}/duplicate |
Duplicate a message template.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
Connect the brand's OWN CRM (GoHighLevel). Requires a plan that includes CRM integration (403 CRM_TIER_REQUIRED otherwise).
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/crm/connection |
CRM connection status (safe projection — no secret).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| DELETE | /api/v1/crm/connection |
Disconnect the brand's CRM.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/crm/status |
CRM at a glance — connection status, sequences and recent runs (no contacts).
key
SchemasResponse 200
{
"success": true,
"data": {
"plan": {
"includesCrm": true
},
"connection": {
"provider": "string",
"authMode": "string",
"status": "string",
"lastError": "string",
"lastSyncAt": "2026-01-01T00:00:00Z",
"capabilities": null,
"hasCredentials": true,
"phiSyncEnabled": true
},
"sequences": {
"total": 0,
"byStatus": {},
"items": [
{
"id": "string",
"name": "string",
"status": "string",
"isActive": true,
"runs": {},
"lastRunAt": "2026-01-01T00:00:00Z"
}
]
},
"recentRuns": [
{
"id": "string",
"sequenceId": "string",
"status": "string",
"triggerEvent": "string",
"currentStepIndex": 0,
"startedAt": "2026-01-01T00:00:00Z",
"completedAt": "2026-01-01T00:00:00Z",
"nextRunAt": "2026-01-01T00:00:00Z",
"attempts": 0,
"emailsSent": 0,
"smsSent": 0,
"failureReason": "string",
"createdAt": "2026-01-01T00:00:00Z"
}
]
}
}
|
| POST | /api/v1/crm/connect/apikey |
Connect a CRM via GHL API key.
key · write
SchemasRequest body (application/json)
{
"provider": "gohighlevel",
"apiKey": "<ghl-api-key>"
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/crm/connect/oauth/start |
Build the GHL OAuth authorize URL (signed state; no mutation).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| PATCH | /api/v1/crm/connection/phi-sync |
Enable or disable patient-data (PHI) sync to the connected CRM.
key · write
SchemasRequest body (application/json)
{
"phiSyncEnabled": true,
"baaAttested": true
}
Response 200
{
"success": true,
"data": {}
}
|
Affiliate/referral module. Requires a plan that includes Affiliates, resolved from the key's clinic (403 AFFILIATES_TIER_REQUIRED otherwise). The brand pays its affiliates directly from its own account, by the method it chooses; FUSE never sends affiliate payments. Payouts here are the brand's record of what it owes and has paid.
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/affiliate-program |
Affiliate program config for the clinic.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| PUT | /api/v1/affiliate-program |
Update affiliate program config (rates, cookie window, payout thresholds).
key · write
SchemasRequest body (application/json)
{
"affiliateProgramEnabled": true,
"affiliateCommissionMode": "percentage",
"affiliateFirstOrderRate": 20,
"affiliateDefaultRate": 10,
"affiliateCommissionDurationMonths": 12,
"affiliateCookieWindowDays": 30,
"affiliateMinimumPayoutThreshold": 50,
"affiliatePayoutFrequency": "monthly",
"affiliateMaxCount": 100
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/affiliate-program/margin-estimate |
Estimated margin impact of the current commission config.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/affiliate-program/affiliates |
List the clinic's affiliates.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| PATCH | /api/v1/affiliate-program/affiliates/{membershipId} |
Update per-affiliate rate overrides / payout details.
key · write
SchemasRequest body (application/json)
{
"firstOrderRate": 25,
"commissionRate": 12,
"payoutContactMethod": "email",
"payoutNotes": "..."
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/affiliate-program/affiliates/invite |
Invite an affiliate by email.
key · write
SchemasRequest body (application/json)
{
"email": "partner@example.com"
}
Response 201
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/affiliate-program/affiliates/{membershipId}/activate |
Reactivate an affiliate.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/affiliate-program/affiliates/{membershipId}/deactivate |
Deactivate an affiliate.
key · write
SchemasRequest body (application/json)
{
"keepCommission": false
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/affiliate-program/commission-report |
Affiliate commission report (read-only).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/affiliate-program/payouts |
List affiliate payouts.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/affiliate-program/payouts/generate |
Generate the next payout batch from accrued commissions.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/affiliate-program/payouts/{id}/commissions |
Commissions included in a payout.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/affiliate-program/payouts/{id}/approve |
Approve a pending payout.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/affiliate-program/payouts/{id}/mark-paid |
Record that the brand has paid a payout from its own account.
key · write
SchemasRequest body (application/json)
{
"notes": "Paid via ACH"
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/affiliate-program/payouts/{payoutId}/exclude-commissions |
Exclude specific commissions from a payout.
key · write
SchemasRequest body (application/json)
{
"commissionIds": [
"<commission-uuid>"
]
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/affiliate-program/tax-documents |
List affiliate W-9 / tax documents for review.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/affiliate-program/tax-documents/{docId}/verify |
Mark a tax document verified.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/affiliate-program/tax-documents/{docId}/reject |
Reject a tax document (reason required).
key · write
SchemasRequest body (application/json)
{
"reason": "Illegible — please resubmit"
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/affiliate-program/tiers |
Create a commission tier.
key · write
SchemasRequest body (application/json)
{
"minActiveReferrals": 5,
"percentage": 15,
"label": "Silver"
}
Response 201
{
"success": true,
"message": "string",
"data": null
}
|
| DELETE | /api/v1/affiliate-program/tiers/{tierId} |
Delete a commission tier.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
Brand-staff management — staff identity and 2FA status, and granting or revoking FUSE platform access.
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/team/members |
Brand-staff roster + pending team invitations (no patient PHI).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/team/invite |
Invite a team member.
key · write
SchemasRequest body (application/json)
{
"email": "colleague@brand.com",
"role": "member"
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| DELETE | /api/v1/team/invitations/{invitationId} |
Revoke a pending team invitation.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| DELETE | /api/v1/team/{userId} |
Remove a team member from the clinic.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| PATCH | /api/v1/team/{userId}/role |
Change a team member's role ('admin' or 'member'; ownership cannot be assigned via
the API).
key · write
SchemasRequest body (application/json)
{
"role": "admin"
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
Clinic settings: the clinic record, fee configuration, organization profile, SendGrid email-domain authentication and logo upload.
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/clinic |
The key clinic's profile.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/config/fees |
Fee configuration for the clinic (pharmacy, doctor, Stripe, merchant fees).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/organization |
The key clinic's org settings + notification config.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/clinic/email-domain |
SendGrid email-domain authentication status.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| PUT | /api/v1/clinic/email-sender |
Update the reply-to email sender address.
key · write
SchemasRequest body (application/json)
{
"replyTo": "support@brand.com"
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/clinic/email-domain/start |
Start SendGrid domain authentication (returns DNS records to add).
key · write
SchemasRequest body (application/json)
{
"domain": "brand.com",
"fromLocalPart": "support"
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/clinic/email-domain/verify |
Verify the SendGrid domain authentication DNS records.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/clinic/email-domain/remove |
Remove SendGrid domain authentication.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/clinic/{id}/upload-logo |
Upload the clinic logo (multipart, field `logo`; :id is ignored, always the key's
own clinic).
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
Storefront/portal config (CustomWebsite). No PHI. logo-proxy is a CORS-convenience byte proxy.
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/custom-website |
The clinic's storefront config.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/custom-website |
Create/update the storefront config.
key · write
SchemasRequest body (application/json)
{
"heroPrimaryButtonText": "Get started",
"isActive": true,
"footerColor": "#111827",
"socialMediaLinks": {
"instagram": "https://instagram.com/brand"
}
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/custom-website/toggle-active |
Enable/disable the custom website.
key · write
SchemasRequest body (application/json)
{
"isActive": true
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/custom-website/reset-footer |
Reset footer content to defaults.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/custom-website/reset-social-media |
Reset social-media links to defaults.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/custom-website/upload-logo |
Upload the storefront logo (multipart, field `logo`).
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/custom-website/upload-hero |
Upload the storefront hero image (multipart, field `heroImage`).
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/custom-website/logo-proxy |
CORS-convenience proxy that streams the storefront logo bytes.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
Patient support threads + tickets. Contains patient PHI (authors + messages). Every handler 404s anything outside the key's clinic.
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/conversations/{id} |
One support conversation thread (own-clinic only).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/conversations/{id}/messages |
Post a message to a conversation.
key · write
SchemasRequest body (application/json)
{
"message": "Thanks for reaching out — how can we help?",
"isInternalNote": false
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/conversations/{id}/resolve |
Mark a conversation resolved.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/support/tickets |
List the clinic's support tickets.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/support/users |
Users available for support-ticket assignment.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/support/tickets/{id}/messages |
Post a message on a support ticket.
key · write
SchemasRequest body (application/json)
{
"message": "We've escalated this to the pharmacy."
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/support/tickets/{id} |
One support ticket (own-clinic only).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| PUT | /api/v1/support/tickets/{id} |
Update a support ticket (title/description/assignment/status).
key · write
SchemasRequest body (application/json)
{
"title": "Shipment delayed",
"description": "...",
"assignedTeam": "fulfillment",
"status": "in_progress"
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/support/ai-settings |
The AI auto-reply settings for the patient portal's Help & Support.
key
SchemasResponse 200
{
"success": true,
"data": {
"aiAutoReplyEnabled": true,
"aiConfidenceThreshold": 0,
"updatedAt": "2026-01-01T00:00:00Z"
}
}
|
| PUT | /api/v1/support/ai-settings |
Turn the patient-support AI on or off, or tune its confidence threshold.
key · write
SchemasRequest body (application/json)
{
"aiAutoReplyEnabled": true
}
Response 200
{
"success": true,
"data": {
"aiAutoReplyEnabled": true,
"aiConfidenceThreshold": 0,
"updatedAt": "2026-01-01T00:00:00Z"
}
}
|
| GET | /api/v1/support/help-docs |
List the brand's help docs.
key
SchemasResponse 200
{
"success": true,
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"title": "string",
"slug": "string",
"body": "string",
"isPublished": true,
"updatedAt": "2026-01-01T00:00:00Z"
}
]
}
|
| POST | /api/v1/support/help-docs |
Create a help doc.
key · write
SchemasRequest body (application/json)
{
"title": "How do I change my shipping address?",
"body": "Open Settings in your patient portal, then Shipping address."
}
Response 201
{
"success": true,
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"title": "string",
"slug": "string",
"body": "string",
"isPublished": true,
"updatedAt": "2026-01-01T00:00:00Z"
}
}
|
| PUT | /api/v1/support/help-docs/{id} |
Update, publish or unpublish a help doc.
key · write
SchemasRequest body (application/json)
{
"isPublished": true
}
Response 200
{
"success": true,
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"title": "string",
"slug": "string",
"body": "string",
"isPublished": true,
"updatedAt": "2026-01-01T00:00:00Z"
}
}
|
Global-product intake-form builder (TenantProductForm rows).
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/forms/global-products |
List the clinic's global-product intake forms.
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/forms/global-products |
Attach an intake form to a global product.
key · write
SchemasRequest body (application/json)
{
"globalProductId": "<global-product-uuid>",
"formId": "<form-uuid>"
}
Response 201
{
"success": true,
"message": "string",
"data": null
}
|
| DELETE | /api/v1/forms/global-products |
Detach an intake form from a global product.
key · write
SchemasRequest body (application/json)
{
"formId": "<form-uuid>"
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/intake-requests |
The clinic's own intake-form requests (no PHI).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/intake-requests |
Create an intake-form request (requestedByUserId stored NULL for a key actor).
key · write
SchemasRequest body (application/json)
{
"treatmentName": "New treatment intake",
"notes": "..."
}
Response 201
{
"success": true,
"message": "string",
"data": null
}
|
| Method | Path | Summary |
|---|---|---|
| POST | /api/v1/upload/logo |
Upload a logo to S3 and set Clinic.logo for the key's clinic (multipart, field
`logo`).
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/teleform-removals |
Teleform wind-down rows for the clinic (no PHI).
key
SchemasResponse 200
{
"success": true,
"message": "string",
"data": null
}
|
| POST | /api/v1/teleform-removals/{id}/cancel |
Cancel a scheduled teleform removal (own-clinic only).
key · write
SchemasRequest body (application/json)
{
"reason": "Keeping this form active"
}
Response 200
{
"success": true,
"message": "string",
"data": null
}
|
| GET | /api/v1/notifications |
List the brand's notifications.
key
SchemasResponse 200
{
"success": true,
"data": {
"notifications": [
{}
],
"unreadCount": 0,
"total": 0
}
}
|
| POST | /api/v1/notifications/read |
Mark brand notifications as read.
key · write
SchemasRequest body (application/json)
{
"ids": [
"00000000-0000-0000-0000-000000000000"
]
}
Response 200
{
"success": true,
"data": {
"updated": 0
}
}
|
| GET | /api/v1/coupons |
List the brand's customer coupons.
key
SchemasResponse 200
{
"success": true,
"data": [
{}
]
}
|
| POST | /api/v1/coupons |
Create a customer coupon.
key · write
SchemasRequest body (application/json)
{
"code": "string",
"description": null,
"discountType": "percent",
"discountValue": 0,
"startsAt": null,
"expiresAt": null,
"isActive": true,
"scope": "first_charge",
"overMarginBehavior": "reject",
"maxRedemptions": null,
"perCustomerLimit": null,
"minOrderAmount": null
}
Response 201
{
"success": true,
"data": {}
}
|
| GET | /api/v1/coupons/{id} |
Get one of the brand's coupons.
key
SchemasResponse 200
{
"success": true,
"data": {}
}
|
| PUT | /api/v1/coupons/{id} |
Update one of the brand's coupons.
key · write
SchemasRequest body (application/json)
{
"code": "string",
"description": null,
"discountType": "percent",
"discountValue": 0,
"startsAt": null,
"expiresAt": null,
"isActive": true,
"scope": "first_charge",
"overMarginBehavior": "reject",
"maxRedemptions": null,
"perCustomerLimit": null,
"minOrderAmount": null
}
Response 200
{
"success": true,
"data": {}
}
|
| DELETE | /api/v1/coupons/{id} |
Delete one of the brand's coupons.
key · write
SchemasResponse 200
{
"success": true
}
|
| GET | /api/v1/coupons/{id}/performance |
Coupon performance (redemptions, discount totals).
key
SchemasResponse 200
{
"success": true,
"data": {}
}
|
| GET | /api/v1/pharmacy-price-changes/alerts |
List outstanding pharmacy price-change alerts.
key
SchemasResponse 200
{
"success": true,
"data": {
"count": 0,
"alerts": [
{
"id": "00000000-0000-0000-0000-000000000000",
"productId": null,
"programId": null,
"globalProductId": null,
"direction": "increase",
"currentProgramFee": null,
"suggestedProgramFee": null,
"perUnitMarginDelta": null,
"status": "string",
"createdAt": "2026-01-01T00:00:00Z"
}
]
}
}
|
| POST | /api/v1/pharmacy-price-changes/alerts/{alertId}/acknowledge |
Acknowledge a pharmacy price-change alert.
key · write
SchemasResponse 200
{
"success": true,
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"status": "string"
}
}
|
Moving a Developer Preview sandbox to a live brand. Sandbox keys only; a live brand's key is told it is already live.
| Method | Path | Summary |
|---|---|---|
| POST | /api/v1/sandbox/go-live |
Retired — use POST /api/v1/sandbox/go-live/link.
key · write
|
| POST | /api/v1/sandbox/go-live/link |
Get a private link to the hosted Go live page.
key · write
SchemasResponse 200
{
"success": true,
"message": "string",
"data": {
"alreadyLive": true,
"url": "string",
"choices": {
"diy": {
"url": "string",
"label": "string"
},
"guided": {
"url": "string",
"label": "string",
"tiers": [
"growth"
]
}
},
"expiresAt": "2026-01-01T00:00:00Z",
"steps": [
"string"
]
}
}
|
| Method | Path | Summary |
|---|---|---|
| POST | /api/v1/checkout/sessions |
Create a checkout session for one of the clinic's own programs
key · write
SchemasRequest body (application/json)
{
"programId": "00000000-0000-0000-0000-000000000000",
"metadata": {},
"successUrl": null
}
Response 201
{
"success": true,
"data": {
"sessionId": "00000000-0000-0000-0000-000000000000",
"sessionToken": "string",
"embedUrl": "string",
"expiresAt": "2026-01-01T00:00:00Z"
}
}
|
| GET | /api/v1/checkout/sessions/{id} |
Get checkout session status (own-clinic only)
key
SchemasResponse 200
{
"success": true,
"data": {
"sessionId": "00000000-0000-0000-0000-000000000000",
"status": "created",
"orderId": null,
"expiresAt": "2026-01-01T00:00:00Z"
}
}
|
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/webhooks |
List the clinic's webhook endpoints (secrets omitted)
key
SchemasResponse 200
{
"success": true,
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"url": "string",
"events": [
"string"
],
"isActive": true,
"lastTriggeredAt": "2026-01-01T00:00:00Z",
"consecutiveFailures": 0
}
]
}
|
| POST | /api/v1/webhooks |
Register an outbound webhook endpoint
key · write
SchemasRequest body (application/json)
{
"url": "string",
"events": [
"session.completed"
]
}
Response 201
{
"success": true,
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"url": "string",
"events": [
"string"
],
"isActive": true,
"secret": "string"
}
}
|
| DELETE | /api/v1/webhooks/{id} |
Delete a webhook endpoint (own-clinic only)
key · write
SchemasResponse 200
{
"success": true,
"data": {
"id": "00000000-0000-0000-0000-000000000000"
}
}
|