Export a workspace's 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 clinic's identity and address, shared settings, PIMS department mappings, workspace term list and, when configured, the letterhead image as a base64 PNG. Requires admin rights in the workspace (workspace admin or superadmin, or an admin of an organization the clinic belongs to). Accepts a browser session or a personal API key; organization and workspace API keys (sk_org_…, sk_ws_…) get 403.
Request
- Base URLhttps://vetnio.com/api/v2
- URLhttps://vetnio.com/api/v2/workspaces/{workspaceId}/data-export/content
- AuthHTTP bearer
Path parameters
Identifier of the workspace (clinic) to export. The caller must be an admin of it, directly or as an admin of its organization.
Response
Successful response
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": "workspace",
"configuration": {
"id": "furunculotic-loud-chihuahua",
"name": "Riverside Animal Clinic",
"createdAt": "2026-09-28T08:15:00.000Z",
"address": "12 Harbour Street",
"city": "Riverside",
"stateProvince": "Riverside County",
"zipCode": "114 51",
"countryCode": "SE",
"taxId": "SE556677889001",
"phone": "+46 8 123 456 78",
"allowPasswords": true,
"templatePermissions": "full_access",
"audioFileRetentionPeriodInDays": 365,
"manualPimsKind": "provet",
"manualPimsName": "ClinicDesk",
"settings": {
"consultationVisibility": "workspace",
"dateFormat": "DD-MM-YYYY",
"documentHeader": {
"headerType": "preset_1",
"customText": "Riverside Animal Clinic. AI-assisted record, reviewed by the attending veterinarian.",
"enabledDocumentTypes": [
"clinical_note",
"referral"
]
},
"pdfExportClinicDetails": {
"clinic": "Riverside Animal Clinic",
"address": "12 Harbour Street, Riverside",
"zipCode": "114 51",
"phone": "+46 8 123 456 78"
},
"pdfLetterhead": {
"templateId": "clean-letterhead",
"enabled": true,
"includeClinicInfo": true,
"fontId": "classic-serif",
"logoFit": "contain",
"accentColor": "#2f6f8f"
},
"globalTemplateInstructions": {
"general": "Use metric units throughout.",
"clinicalNote": "Record body weight in kilograms with one decimal.",
"referral": "Start with the specific question for the receiving clinic.",
"communication": "Sign off as the Riverside Animal Clinic team."
},
"patientMatchingEnabled": true,
"aiTitlesEnabled": true,
"aiTitlesUseAsName": true,
"aiTitlesNamingStyle": "patient_and_case",
"aiTitlesCustomPrompt": "Use the patient name followed by the reason for the visit.",
"recordingAutoStopSeconds": 7200,
"recordingView": "briefing",
"recordingAutoStopPerSession": true,
"recordingConcurrencyControl": {
"enabled": true,
"heartbeatTimeoutSeconds": 90
},
"phoneCallIntegrationEnabled": true,
"phoneProvider": "telavox",
"phoneCallSpellingCorrection": {
"enabled": true,
"employeeNames": [
"Sam Lee",
"Alex Morgan"
],
"additionalContext": "We often mention Librela and Bravecto."
},
"phoneCallSummaryStyle": {
"format": "bullets",
"verbosity": "medium"
},
"provetPhoneCalls": {
"enabled": true,
"providerId": "0b7e3c9a-4f2d-4e1b-8a6c-9d5f2e1a7b3c",
"departmentId": 4,
"templatesText": "## Triage\nReason for call:\nAdvice given:",
"routingInstructions": "Use Triage for calls about acute illness or injury.",
"timeZone": "Europe/Stockholm",
"night": {
"startHour": 20,
"endHour": 8,
"templateName": "Triage"
}
},
"provetExportMode": "consultation_items",
"revenueRecoverySuggestionPolicy": {
"bundlePolicy": "bundles_first",
"excludedCategories": [
"retail",
"lab"
],
"searchHiddenCategories": [
"lab"
],
"requiredCategories": [
{
"id": "consultation-fee",
"label": "Consultation fee",
"instruction": "Choose by visit length: under 20 minutes is a short consultation.",
"rule": "always_one"
}
]
},
"aiReceptionist": {
"enabled": true,
"defaultLocale": "sv-SE",
"timeZone": "Europe/Stockholm",
"emergencyPhone": "+46 8 123 456 78",
"pimsKind": "provet",
"bookingConfig": {
"minimumNoticeMinutes": 120
}
},
"saveAnimanaPatients": true
},
"pimsDepartmentMappings": [
{
"instanceId": "8070",
"departmentId": "4",
"createdAt": "2026-09-28T08:15:00.000Z",
"updatedAt": "2026-09-28T08:15:00.000Z"
}
],
"catalogSwitches": {
"items": [
{
"itemId": "4b1d7c2e-9a3f-4e8b-b6d1-2c5f8e9a7b30",
"suggest": "on"
}
],
"bundles": [
{
"bundleId": "9e2f5d1b-7a9c-4e42-8b4d-3f6c2a1e0c7a",
"sourceTemplateId": "117",
"suggest": "on"
}
]
},
"catalogNotes": {
"items": [
{
"itemId": "4b1d7c2e-9a3f-4e8b-b6d1-2c5f8e9a7b30",
"description": "Every senior work-up. Not for rechecks.",
"updatedAt": "2026-10-20T09:00:00.000Z"
}
],
"bundles": [
{
"bundleId": "9e2f5d1b-7a9c-4e42-8b4d-3f6c2a1e0c7a",
"sourceTemplateId": "117",
"description": "Every senior work-up. Not for rechecks.",
"updatedAt": "2026-10-20T09:00:00.000Z"
}
]
},
"catalogVisitFees": {
"items": [
{
"itemId": "4b1d7c2e-9a3f-4e8b-b6d1-2c5f8e9a7b30",
"decision": "visit_fee",
"decidedAt": "2026-10-28T09:00:00.000Z"
}
]
},
"letterheadAsset": {
"mimeType": "image/png",
"encoding": "base64"
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.