data-export
customer-content

Export your settings and transcription terms

Exports the current stored settings and the current transcription term list of exactly this scope as versioned JSON (schemaVersion 1), with an inventory that lists what is included, what is excluded and how to interpret it. Credentials, billing identifiers and other scopes' private settings are never included. Values are read at request time, so this is neither a change history nor an atomic snapshot. Read-only. Covers the caller's personal preferences, custom AI instructions and personal term list. Returns only the caller's own settings; no user ID can be passed. Accepts a browser session or a personal API key; organization and workspace API keys (sk_org_…, sk_ws_…) get 403.

get/users/me/data-export/content

Request

  • Base URL
    https://vetnio.com/api/v2
  • URL
    https://vetnio.com/api/v2/users/me/data-export/content
  • Auth
    HTTP bearer

Response

Successful response

schemaVersion1 required

Version of the export format. Currently always 1.

exportedAtstring date-time required

When this export was produced (ISO 8601, UTC). Values are read separately, so this is not the time of an atomic snapshot.

scopeIdstring required

ID of the exported user, workspace or organization. Equal to configuration.id.

scope'user' required

Exported scope. Always user for this endpoint.

Example response

{
  "schemaVersion": 1,
  "exportedAt": "2026-09-28T08:15:00.000Z",
  "scopeId": "furunculotic-loud-chihuahua",
  "termList": {
    "terms": [
      "Librela",
      "Apoquel",
      "Bravecto"
    ],
    "version": 3,
    "updatedAt": "2026-09-28T08:15:00.000Z",
    "updatedBy": "7d1f0c3e-2a4b-4e8f-9c61-5b2a8d4e7f10"
  },
  "inventory": {
    "included": [
      "Workspace identity, address and allowlisted settings",
      "Current workspace transcription term list"
    ],
    "excluded": [
      "Credentials, API keys, OAuth/session/password material and provider connection secrets"
    ],
    "limitations": [
      "Current stored values only; separate reads do not form an atomic snapshot"
    ]
  },
  "scope": "user",
  "configuration": {
    "id": "7d1f0c3e-2a4b-4e8f-9c61-5b2a8d4e7f10",
    "name": "Dr. Sam Lee",
    "preferences": {
      "savedRecordingLanguageCodeSelection": "sv",
      "savedTranslationLanguageCodeSelection": "en",
      "savedPdfLanguageSelection": "en",
      "pdfExportPractitioner": {
        "name": "Dr. Sam Lee",
        "email": "sam.lee@example.com"
      },
      "preferredWorkspaceId": "furunculotic-loud-chihuahua",
      "consultationsPerPage": 25,
      "customSystemInstructionGeneral": "Use metric units and British spelling.",
      "customSystemInstructionClinicalNotes": "List any vaccinations given at the end of the note.",
      "customSystemInstructionCommunications": "Address the owner by first name and keep a friendly tone.",
      "customSystemInstructionVetsGPT": "Cite the source of any dosage you mention.",
      "recordingAutoStopSeconds": 3600,
      "recordingAutoStopPerSession": true,
      "recordingSilenceAlertSound": "chime",
      "clinicalNoteGenerationNoticeEnabled": true,
      "manualWritingEnabled": true,
      "noteEditorFontSize": "large",
      "noteEditorFontFamily": "serif",
      "copilotMode": "manual",
      "colorMode": "light",
      "provetExportTargets": "clinicalNote",
      "provetImagingReferralField": "answer_remarks"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.