FUSE Health CRM · Contacts API

openapi: 3.2.0
info:
  title: FUSE Brand API (External) CRM · Contacts 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 · Contacts
paths:
  /api/v1/contacts:
    get:
      tags:
      - CRM · Contacts
      summary: List contacts (patients)
      operationId: getApiV1Contacts
      description: List contacts (patients).
      security:
      - ApiKeyAuth: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 50
        example: '50'
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          default: 0
        example: '0'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Contact'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      tags:
      - CRM · Contacts
      summary: Create a contact (provisions a patient + welcome email)
      operationId: postApiV1Contacts
      description: Create a contact (provisions a patient + welcome email).
      security:
      - ApiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                firstName:
                  type: string
                lastName:
                  type: string
                email:
                  type: string
            example:
              firstName: Jane
              lastName: Doe
              email: jane@example.com
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    $ref: '#/components/schemas/Contact'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /api/v1/contacts/{id}:
    put:
      tags:
      - CRM · Contacts
      summary: Update a contact
      operationId: putApiV1ContactsById
      description: Update a contact.
      security:
      - ApiKeyAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                firstName:
                  type: string
            example:
              firstName: Jane
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    $ref: '#/components/schemas/Contact'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /api/v1/contacts/{id}/marketing-consent:
    put:
      tags:
      - CRM · Contacts
      summary: Record or withdraw a contact's consent to marketing email
      operationId: putApiV1ContactsByIdMarketingconsent
      description: 'Sequence emails are marketing: they are sent only to contacts who agreed to receive them. Granting consent requires your attestation and the basis (how and when the contact agreed); both are kept in the audit log. Withdrawing needs neither. A contact who unsubscribed (`CONTACT_UNSUBSCRIBED`) or turned marketing email off in their own account (`CONTACT_DECLINED`) can''t be opted back in this way; only they can.'
      security:
      - ApiKeyAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - consented
              properties:
                consented:
                  type: boolean
                attestation:
                  type: boolean
                  description: Required (true) when consented is true.
                consentSource:
                  type: string
                  enum:
                  - web_form
                  - paper_form
                  - verbal
                  - email
                  - imported_list
                  - other
                  description: Required when consented is true.
                consentObtainedAt:
                  type: string
                  format: date
                  description: When the contact agreed. Required when consented is true; not in the future.
            example:
              consented: true
              attestation: true
              consentSource: web_form
              consentObtainedAt: '2026-10-01'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      notifyProductNews:
                        type: boolean
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: The contact unsubscribed or turned marketing email off themselves; only they can opt back in.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  code:
                    type: string
                    enum:
                    - CONTACT_UNSUBSCRIBED
                    - CONTACT_DECLINED
                  message:
                    type: string
  /api/v1/contacts/import:
    post:
      tags:
      - CRM · Contacts
      summary: Bulk CSV import (multipart, field `csv`, 5 MB).
      operationId: postApiV1ContactsImport
      description: 'Bulk CSV import (multipart, field `csv`, 5 MB). Headers: firstname,lastname,email[,phonenumber]. Patient emails are redacted from error rows.'
      security:
      - ApiKeyAuth: []
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                csv:
                  type: string
                  format: binary
                  description: Upload file field
              required:
              - csv
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    $ref: '#/components/schemas/Contact'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    Tag:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        description:
          type:
          - string
          - 'null'
        category:
          type: string
        color:
          type: string
        clinicId:
          type: string
          format: uuid
        isActive:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Contact:
      type: object
      properties:
        id:
          type: string
          format: uuid
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        phoneNumber:
          type:
          - string
          - 'null'
        emailOptedOut:
          type: boolean
        smsOptedOut:
          type: boolean
        notifyProductNews:
          type: boolean
          description: The contact opted in to marketing email. Sequence emails are sent only to contacts where this is true.
        notifySmsUpdates:
          type: boolean
          description: The contact opted in to text messages. Sequence SMS steps are sent only when this is true.
        optOutDate:
          type:
          - string
          - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
        lastLoginAt:
          type:
          - string
          - 'null'
          format: date-time
        lastContactDate:
          type:
          - string
          - 'null'
          format: date-time
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    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: {}
  responses:
    Forbidden:
      description: Authenticated but not permitted (insufficient scope, wrong role, or FUSE feature not enabled)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Resource not found (or not owned by the key's clinic)
      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'
  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.