FUSE Health CRM · Connection API

openapi: 3.2.0
info:
  title: FUSE Brand API (External) CRM · Connection 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: CRM · Connection
  description: Connect the brand's OWN CRM (GoHighLevel). Requires a plan that includes CRM integration (403 CRM_TIER_REQUIRED otherwise).
paths:
  /api/v1/crm/connection:
    get:
      tags:
      - CRM · Connection
      summary: CRM connection status (safe projection — no secret)
      operationId: getApiV1CrmConnection
      description: CRM connection status (safe projection — no secret).
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
    delete:
      tags:
      - CRM · Connection
      summary: Disconnect the brand's CRM
      operationId: deleteApiV1CrmConnection
      description: Disconnect the brand's CRM.
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v1/crm/status:
    get:
      tags:
      - CRM · Connection
      summary: CRM at a glance — connection status, sequences and recent runs (no contacts)
      operationId: getApiV1CrmStatus
      description: The CRM connection's safe status (provider, status, last error, last sync, capabilities — never a credential), whether the brand's plan includes CRM, every sequence with its runs counted by status, and the most recent sequence runs (status, trigger, timings and send counts). Never a contact, a run payload or a user id; email addresses and phone numbers in a last error or failure reason are replaced.
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    $ref: '#/components/schemas/CrmStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/crm/connect/apikey:
    post:
      tags:
      - CRM · Connection
      summary: Connect a CRM via GHL API key
      operationId: postApiV1CrmConnectApikey
      description: Connect a CRM via GHL API key.
      security:
      - ApiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                provider:
                  type: string
                apiKey:
                  type: string
            example:
              provider: gohighlevel
              apiKey: <ghl-api-key>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v1/crm/connect/oauth/start:
    get:
      tags:
      - CRM · Connection
      summary: Build the GHL OAuth authorize URL (signed state; no mutation)
      operationId: getApiV1CrmConnectOauthStart
      description: Build the GHL OAuth authorize URL (signed state; no mutation).
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/crm/connection/phi-sync:
    patch:
      tags:
      - CRM · Connection
      summary: Enable or disable patient-data (PHI) sync to the connected CRM
      operationId: patchApiV1CrmConnectionPhisync
      description: 'Toggles PHI egress to the clinic''s connected CRM. Enabling requires `baaAttested: true` in the body AND the verified BAA on file with FUSE — otherwise 403 `CRM_BAA_REQUIRED`. Disabling is always permitted. 409 if no CRM is connected. Requires the `write` scope.'
      security:
      - ApiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - phiSyncEnabled
              properties:
                phiSyncEnabled:
                  type: boolean
                baaAttested:
                  type: boolean
                  description: Must be true when enabling — confirms the brand holds a BAA with its CRM provider.
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          description: No CRM connected for this clinic.
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'
    BadRequest:
      description: Bad request / business-rule failure (may include a `code`)
      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: {}
    CrmStatus:
      type: object
      properties:
        plan:
          type: object
          properties:
            includesCrm:
              type: boolean
        connection:
          type:
          - object
          - 'null'
          properties:
            provider:
              type: string
            authMode:
              type:
              - string
              - 'null'
            status:
              type: string
            lastError:
              type:
              - string
              - 'null'
            lastSyncAt:
              type:
              - string
              - 'null'
              format: date-time
            capabilities: {}
            hasCredentials:
              type: boolean
            phiSyncEnabled:
              type: boolean
        sequences:
          type: object
          properties:
            total:
              type: integer
            byStatus:
              type: object
              additionalProperties:
                type: integer
            items:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  status:
                    type: string
                  isActive:
                    type: boolean
                  runs:
                    type: object
                    additionalProperties:
                      type: integer
                  lastRunAt:
                    type:
                    - string
                    - 'null'
                    format: date-time
        recentRuns:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              sequenceId:
                type: string
              status:
                type: string
              triggerEvent:
                type: string
              currentStepIndex:
                type: integer
              startedAt:
                type:
                - string
                - 'null'
                format: date-time
              completedAt:
                type:
                - string
                - 'null'
                format: date-time
              nextRunAt:
                type:
                - string
                - 'null'
                format: date-time
              attempts:
                type: integer
              emailsSent:
                type: integer
              smsSent:
                type: integer
              failureReason:
                type:
                - string
                - 'null'
              createdAt:
                type: string
                format: date-time
  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.