FUSE Health Developer Sandbox API

openapi: 3.2.0
info:
  title: FUSE Brand API (External) Developer Sandbox API
  version: 1.0.0
  description: 'Server-to-server API exposing the FUSE brand-admin surface so a single brand/tenant can build its own admin frontend. Every request is authenticated with an API key bound to exactly one clinic; all data is auto-scoped to that clinic and cannot reach another brand''s data. Isolation is enforced by application-layer clinic filtering on every query.


    COVERAGE: 218 operations across 180 paths, and EVERY ONE is available to every brand. There is no per-clinic enablement step. What governs access: your API key and its scopes, the clinic the key belongs to (every read and write is filtered to it), your plan''s entitlements for the two commercially-gated areas — Affiliates (`AFFILIATES_TIER_REQUIRED`) and CRM Connect (`CRM_TIER_REQUIRED`) — and rate limits.


    AUTH: the external /api/v1 surface uses an API key (`x-api-key`, ApiKeyAuth). Key management (/api-keys) and /auth/signin live at the API root and use a brand-admin JWT (BearerAuth); /auth/signin itself is unauthenticated.


    SCOPES: every key carries scopes; read-only is the default and mutating endpoints require the `write` scope (403 INSUFFICIENT_SCOPE otherwise). Keys default to a 1-year expiry.


    RATE LIMITING: every endpoint may additionally return `429 Too Many Requests` with a `Retry-After` header; 429 is not repeated on each operation below.


    PLATFORM FIELDS: product cost, fees, pharmacy routing, doctor questions and FUSE approvals are set by FUSE, not by the brand. Any write (POST/PUT/PATCH/DELETE) whose JSON body carries one of those fields at any depth — for example `pharmacyPrice`, `shippingFeeUsd`, `coolerFeeUsd`, `pharmacyId`, `preferredPharmacyId`, `pharmacyProvider`, `requiredDoctorQuestions`, `facilitationFee`, `placeholderPrice`, `legalBusinessName`, `isTemplate` or `tenantManagerApproved` — is refused with `403 PLATFORM_FIELD`, whose `fields` array lists the offending paths; remove them and resend. (One exception: `POST /api/v1/products` still accepts the `pharmacyPrice` its schema requires, and ignores it.) 403 PLATFORM_FIELD is not repeated on each operation below.'
servers:
- url: https://api-dev.fusehealth.com
  description: Development
- url: https://api.fusehealth.com
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: Developer Sandbox
  description: Moving a Developer Preview sandbox to a live brand. Sandbox keys only; a live brand's key is told it is already live.
paths:
  /api/v1/sandbox/go-live:
    post:
      tags:
      - Developer Sandbox
      summary: Retired — use POST /api/v1/sandbox/go-live/link
      operationId: postApiV1SandboxGoLive
      deprecated: true
      description: Retired. Going live now happens on the hosted Go live page, which collects the company's details the signer's onboarding needs. Get a private link to it with POST /api/v1/sandbox/go-live/link. This operation always answers 410 `USE_GO_LIVE_PAGE` and sends nothing.
      security:
      - ApiKeyAuth: []
      responses:
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '410':
          description: USE_GO_LIVE_PAGE — retired; use POST /api/v1/sandbox/go-live/link.
  /api/v1/sandbox/go-live/link:
    post:
      tags:
      - Developer Sandbox
      summary: Get a private link to the hosted Go live page
      operationId: postApiV1SandboxGoLiveLink
      description: 'Returns a private link, valid for 30 minutes, that opens the hosted Go live page already signed in as the developer, and `choices` — the two ways to go live, each with its own link. `diy` opens the self-serve form: the developer enters the company''s details exactly as on its formation documents, sees a pre-check of them, chooses a plan, and names the authorized signer (who can be the developer). `guided` opens the "Book a call" step for a guided Growth launch or Partner, which sends the developer to the team''s calendar. Used by the FUSE AI connector when a user asks to go live. A live brand''s key gets `alreadyLive: true` and no link.'
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      alreadyLive:
                        type: boolean
                      url:
                        type:
                        - string
                        - 'null'
                      choices:
                        type: object
                        description: The two ways to go live. Absent when `alreadyLive` is true.
                        properties:
                          diy:
                            type: object
                            properties:
                              url:
                                type: string
                              label:
                                type: string
                          guided:
                            type: object
                            properties:
                              url:
                                type: string
                              label:
                                type: string
                              tiers:
                                type: array
                                items:
                                  type: string
                                  enum:
                                  - growth
                                  - partner
                      expiresAt:
                        type:
                        - string
                        - 'null'
                        format: date-time
                      steps:
                        type: array
                        items:
                          type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: ORGANIZATION_NOT_FOUND — the key's organization no longer exists.
        '409':
          description: NO_DEVELOPER_ACCOUNT — the sandbox has no developer account to sign the link in as.
        '503':
          description: GO_LIVE_PAGE_UNAVAILABLE — the hosted page is not enabled in this environment.
components:
  responses:
    Forbidden:
      description: Authenticated but not permitted (insufficient scope, wrong role, or FUSE feature not enabled)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: Missing, invalid, inactive, or expired API key (or JWT)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    ErrorEnvelope:
      description: 'Failure shape. NOTE: most modules use `message`; programs endpoints use `error`. Read both. Some errors include a machine-readable `code` and/or a `data` payload.'
      type: object
      properties:
        success:
          type: boolean
          enum:
          - false
        message:
          type: string
        error:
          type: string
        code:
          type: string
        data: {}
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Clinic-scoped API key. Keep server-side; never expose in a browser or app bundle.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: FUSE brand-admin JWT (from POST /auth/signin). Used ONLY by the key-management endpoints — the external /api/v1 surface never accepts JWTs, and API keys never work on key management.