Configuration export

Export an organization's settings and transcription terms

GET/organizations/{organizationId}/data-export/content

AcceptsPersonal key

Path parameters

• organizationIdstringrequired

  Identifier of the organization to export (a UUID). The caller must be an admin of it.

Returns

• schemaVersionnumberrequired

  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.

  matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

• scopeIdstringrequired

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

• termListobjectrequired

  The scope's current custom transcription vocabulary: names, abbreviations and specialist terms used as spelling and recognition hints. When no list has been saved, terms is empty, version is 0 and updatedAt and updatedBy are null.

  Show child attributes

  • termsarray of stringsrequired

    Terms in their stored spelling and order. Up to 200 terms, each at most 50 characters and four words. Empty when no list is saved.

  • versionintegerrequired

    Edit-concurrency revision of the list: 1 or higher for a saved list, 0 when none is saved. It increases with each save; earlier contents are not retained.

    ≥ 0 · ≤ 9007199254740991

  • updatedAtstring (date-time)requirednullable

    When the list was last saved (ISO 8601, UTC). null when no list is saved.

    matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • updatedBystringrequirednullable

    ID of the user who last saved the list (a UUID). null when no list is saved or that user's account has been deleted.

• inventoryobjectrequired

  Plain-English statements of what this export covers and how to read it, intended for audit records. The wording can change between releases, so do not parse it.

  Show child attributes

  • includedarray of stringsrequired

    Categories of content included in this response.

  • excludedarray of stringsrequired

    Categories deliberately left out of this response, such as credentials, billing identifiers and other owners' settings.

  • limitationsarray of stringsrequired

    How to interpret this export, for example that it contains current values only and is not an atomic snapshot.

• scopeenumrequired

  Exported scope. Always organization for this endpoint.

• configurationobjectrequired

  Identity, address, email domains, audio retention policy and allowlisted preferences of the organization.

  Show child attributes

  • idstringrequired

    ID of the organization (a UUID).

  • namestringrequired

    Organization name.

  • addressobjectrequirednullable

    Postal address stored for the organization, with unset parts omitted. When the organization is billed as one legal entity (preferences.billingLegalName is set), invoices are addressed here. null when no address has been stored.

    Show child attributes

    • streetstringoptional

      Street address line. Absent when not set.

    • attentionstringoptional

      Attention line of the address, for example a department or contact person. Absent when not set.

    • citystringoptional

      City. Absent when not set.

    • stateProvincestringoptional

      State, province or county. Absent when not set.

    • zipCodestringoptional

      Postal or ZIP code, as entered. Absent when not set.

    • countryCodestringoptional

      Two-letter ISO 3166-1 alpha-2 country code. Absent when not set.

  • customDomainsarray of stringsrequired

    Email domains that belong to the organization. When a user with an address at one of these domains creates a workspace, or joins one through domain matching, that workspace is linked to the organization. Empty when there are none.

  • audioFileRetentionPeriodInDaysintegerrequirednullable

    Audio retention period in days set by the organization (1 to 3650). Consultation and meeting recordings in its clinics older than this are deleted automatically; a clinic's own shorter period still applies. null when not set. Pending change requests are not included.

    ≥ -9007199254740991 · ≤ 9007199254740991

  • createdAtstring (date-time)required

    When the organization was created (ISO 8601, UTC).

    matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • updatedAtstring (date-time)required

    When the organization's stored details were last changed (ISO 8601, UTC).

    matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • preferencesobjectrequired

    The organization's stored preferences. Only allowlisted keys are exported; billing-provider identifiers and integration credentials are left out. A key is absent when never set, and an organization with no stored preferences exports {}.

    Show child attributes

    • billingLegalNamestringoptional

      Legal entity name that invoices for the organization's clinics are addressed to, at the organization address. Absent when each clinic is billed under its own details.

    • billingTaxExemptstringoptional

      VAT treatment of the billing entity, overriding the treatment derived from its country:

      • none — VAT is charged
      • reverse — reverse charge
      • exempt — VAT-exempt Absent when the country-based treatment applies.
    • billingTaxIdstringoptional

      VAT number of the billing entity. It replaces each clinic's own VAT number on invoices. Absent when not set.

    • billingClinicAttentionLinebooleanoptional

      When true, each clinic's name is put on the invoice's attention line so a central accounts-payable team can route the cost. Absent means false.

    • deepResearchUpgradeRequestsEnabledbooleanoptional

      Whether users in the organization's clinics can request the paid Deep Research add-on when their monthly Deep Research quota runs out. A clinic linked to several organizations allows requests if any of them enables this. Absent means false.

    • aiTitlesEnabledbooleanoptional

      Default for AI-generated consultation titles in the organization's clinics. A clinic's own aiTitlesEnabled setting takes precedence; a clinic without one gets titles if any linked organization has true. Absent means not enabled by this organization.

    • recordingViewenumoptional

      Default recording display for the organization's clinics. Each clinic can override it. If several linked organizations specify different defaults, briefing takes precedence. Absent means waveform unless another linked organization selects briefing.

      Possible values:waveformbriefing

    • liveTranscriptionEnabledbooleanoptional

      Default for starting live transcription with consultation recording. Each clinic can override it. If several linked organizations specify different defaults, false takes precedence. Absent means enabled unless another linked organization disables it. Audio recording and transcription after recording are unaffected.

Errors

400

The request is malformed or failed validation.

401

The API key is missing, invalid or revoked.

403

The key is valid but may not perform this action on this resource.

404

The resource does not exist or is not visible to this key.

500

Something went wrong on Vetnio's side.

Export an organization's template blueprints

GET/organizations/{organizationId}/data-export/templates

AcceptsPersonal key

Path parameters

• organizationIdstringrequired

  Identifier of the organization to export (a UUID). The caller must be an admin of it.

Query parameters

• cursorstringoptional

  Pagination cursor: the nextCursor value from the previous page. Omit for the first page, and keep the same owner and template category while paging. Items with an ID greater than the cursor are returned.

  at least 1 characters · at most 512 characters

• limitintegeroptional

  Maximum number of templates per page, 1-50.

  Default 20 · ≥ 1 · ≤ 50

Returns

• nextCursorstringrequirednullable

  Pass this value as cursor to fetch the next page. null when this is the last page.

• expiresInSecondsnumberrequired

  Lifetime of every contentUrl on this page, in seconds.

• expiresAtstring (date-time)required

  When the contentUrl links on this page stop working (ISO-8601 UTC). Download before then. Expiry does not affect the stored content.

  matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

• itemsarray of objectsrequired

  Organization templates on this page, ordered by ascending ID.

  Show child attributes

  • idstringrequired

    Organization template ID.

  • organizationIdstringrequired

    ID of the organization that owns the template (UUID).

  • namestringrequired

    Template name shown in the app.

  • typeenumrequired

    What the template produces:

    • clinical_note — the clinical note (medical record entry) for a consultation.
    • referral — a referral letter to another clinic or specialist.
    • client_communication — a message to the pet owner.
  • createdBystringrequired

    User ID (UUID) of the organization admin who created the template.

  • createdAtstring (date-time)required

    When the template was created (ISO-8601 UTC).

    matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • artifactobjectrequirednullable

    Download of the blueprint body, or null when no stored body exists.

    Show child attributes

    • contentUrlstringrequired

      Signed HTTPS URL that downloads the stored body without further authentication. It expires at the page's expiresAt (one hour); fetch the page again for a fresh link. Treat it as a secret.

    • currentVersionIdstringrequirednullable

      The downloaded version. Null means storage supplied no immutable version ID, including the legacy null version, so the URL follows the current object.

    • contentTypestringrequirednullable

      Media type of the stored body as recorded by storage, for example text/html or application/json, or null if none was recorded.

    • sizenumberrequirednullable

      Size of the stored body in bytes, or null if unknown.

    • lastModifiedstring (date-time)requirednullable

      When the current body was last written (ISO-8601 UTC), or null if unknown.

      matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

Errors

400

The request is malformed or failed validation.

401

The API key is missing, invalid or revoked.

403

The key is valid but may not perform this action on this resource.

404

The resource does not exist or is not visible to this key.

500

Something went wrong on Vetnio's side.

Get a retained version of an organization template

GET/organizations/{organizationId}/data-export/templates/version

AcceptsPersonal key

Path parameters

• organizationIdstringrequired

  Identifier of the organization to export (a UUID). The caller must be an admin of it.

Query parameters

• partenumoptional

  Which stored object of the template to read:

  • content — the template body itself.
  • instructions — the separate instructions object of an imported template (original wording and per-section instructions). Only workspace note and meeting templates have one; other kinds return 400.

  Default content

• templateIdstringrequired

  ID of the template, as returned in items[].id by the matching template export. It must belong to the workspace or organization in the path, otherwise 404.

  at least 1 characters · at most 512 characters

• versionIdstringrequired

  Opaque version ID from the versions list (versions[].versionId) or from artifact.currentVersionId. URL-encode it; it can contain characters such as +, / and =.

  at least 1 characters · at most 2048 characters

Returns

• currentVersionIdstringrequirednullable

  Version ID of the template's current body at the time of the request, or null when there is no current body. Unlike artifact.currentVersionId, a legacy unversioned body is reported here as the literal string "null".

• versionobjectrequired

  Metadata of the requested version.

  Show child attributes

  • versionIdstringrequired

    Opaque stored version ID. A literal null version belongs to unversioned or suspended storage and can be overwritten.

  • isLatestbooleanrequired

    true when this version is the template's current body.

  • lastModifiedstring (date-time)requirednullable

    When this version was stored (ISO-8601 UTC), or null if unknown.

    matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • sizenumberrequirednullable

    Size of this version's body in bytes, or null if unknown.

  • contentTypestringrequirednullable

    Media type of this version's body as recorded by storage, for example text/html or application/json, or null.

  • auditobjectrequirednullable

    Audit details of the edit that saved this version. Only available for workspace note templates and part=content; null otherwise, or when no matching audit entry exists. Not a clinical approval or accuracy classification.

    Show child attributes

    • idstringrequired

      ID of the audit-log entry (UUID).

    • occurredAtstring (date-time)required

      When the change was made (ISO-8601 UTC).

      matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

    • actorNamestringrequirednullable

      Display name of the person who made the change, or null when unknown or for system changes. For changes made by Vetnio support on a customer's behalf, this is the support staff member.

    • actorTypeenumrequired

      Who made the change:

      • user — a member of the customer's team.
      • vetnio_staff — Vetnio staff, for example while providing support.
      • system — an automated process.
    • actionstringrequired

      Audit action that saved this version, for example template.created, template.content_updated or template.restored.

    • s3VersionIdstringrequired

      The stored version ID the audit entry refers to; equals the version's versionId.

• contentstringrequired

  The exact retained body as UTF-8 text, including HTML instructions or the original JSON schema.

Errors

400

The request is malformed or failed validation.

401

The API key is missing, invalid or revoked.

403

The key is valid but may not perform this action on this resource.

404

The resource does not exist or is not visible to this key.

500

Something went wrong on Vetnio's side.

List retained versions of an organization template

GET/organizations/{organizationId}/data-export/templates/versions

AcceptsPersonal key

Path parameters

• organizationIdstringrequired

  Identifier of the organization to export (a UUID). The caller must be an admin of it.

Query parameters

• partenumoptional

  Which stored object of the template to read:

  • content — the template body itself.
  • instructions — the separate instructions object of an imported template (original wording and per-section instructions). Only workspace note and meeting templates have one; other kinds return 400.

  Default content

• templateIdstringrequired

  ID of the template, as returned in items[].id by the matching template export. It must belong to the workspace or organization in the path, otherwise 404.

  at least 1 characters · at most 512 characters

• cursorstringoptional

  Opaque pagination cursor: the nextCursor value from the previous page of this template's versions. Omit for the first page. URL-encode it.

  at least 1 characters · at most 2048 characters

Returns

• currentVersionIdstringrequirednullable

  Version ID of the template's current body at the time of the request, or null when there is no current body. Unlike artifact.currentVersionId, a legacy unversioned body is reported here as the literal string "null".

• versionsarray of objectsrequired

  Retained versions on this page, newest first. A page can hold fewer than 50 versions even when more follow.

  Show child attributes

  • versionIdstringrequired

    Opaque stored version ID. A literal null version belongs to unversioned or suspended storage and can be overwritten.

  • isLatestbooleanrequired

    true when this version is the template's current body.

  • lastModifiedstring (date-time)requirednullable

    When this version was stored (ISO-8601 UTC), or null if unknown.

    matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • sizenumberrequirednullable

    Size of this version's body in bytes, or null if unknown.

  • auditobjectrequirednullable

    Audit details of the edit that saved this version. Only available for workspace note templates and part=content; null otherwise, or when no matching audit entry exists. Not a clinical approval or accuracy classification.

    Show child attributes

    • idstringrequired

      ID of the audit-log entry (UUID).

    • occurredAtstring (date-time)required

      When the change was made (ISO-8601 UTC).

      matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

    • actorNamestringrequirednullable

      Display name of the person who made the change, or null when unknown or for system changes. For changes made by Vetnio support on a customer's behalf, this is the support staff member.

    • actorTypeenumrequired

      Who made the change:

      • user — a member of the customer's team.
      • vetnio_staff — Vetnio staff, for example while providing support.
      • system — an automated process.
    • actionstringrequired

      Audit action that saved this version, for example template.created, template.content_updated or template.restored.

    • s3VersionIdstringrequired

      The stored version ID the audit entry refers to; equals the version's versionId.

• nextCursorstringrequirednullable

  Pass this value as cursor to fetch older versions. null when the history is complete.

Errors

400

The request is malformed or failed validation.

401

The API key is missing, invalid or revoked.

403

The key is valid but may not perform this action on this resource.

404

The resource does not exist or is not visible to this key.

500

Something went wrong on Vetnio's side.

Export your settings and transcription terms

GET/users/me/data-export/content

AcceptsPersonal key

Returns

• schemaVersionnumberrequired

  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.

  matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

• scopeIdstringrequired

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

• termListobjectrequired

  The scope's current custom transcription vocabulary: names, abbreviations and specialist terms used as spelling and recognition hints. When no list has been saved, terms is empty, version is 0 and updatedAt and updatedBy are null.

  Show child attributes

  • termsarray of stringsrequired

    Terms in their stored spelling and order. Up to 200 terms, each at most 50 characters and four words. Empty when no list is saved.

  • versionintegerrequired

    Edit-concurrency revision of the list: 1 or higher for a saved list, 0 when none is saved. It increases with each save; earlier contents are not retained.

    ≥ 0 · ≤ 9007199254740991

  • updatedAtstring (date-time)requirednullable

    When the list was last saved (ISO 8601, UTC). null when no list is saved.

    matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • updatedBystringrequirednullable

    ID of the user who last saved the list (a UUID). null when no list is saved or that user's account has been deleted.

• inventoryobjectrequired

  Plain-English statements of what this export covers and how to read it, intended for audit records. The wording can change between releases, so do not parse it.

  Show child attributes

  • includedarray of stringsrequired

    Categories of content included in this response.

  • excludedarray of stringsrequired

    Categories deliberately left out of this response, such as credentials, billing identifiers and other owners' settings.

  • limitationsarray of stringsrequired

    How to interpret this export, for example that it contains current values only and is not an atomic snapshot.

• scopeenumrequired

  Exported scope. Always user for this endpoint.

• configurationobjectrequired

  Identity and allowlisted personal preferences of the calling user.

  Show child attributes

  • idstringrequired

    The user's ID (a UUID).

  • namestringrequirednullable

    The user's display name. null when not set.

  • preferencesobjectrequired

    The user's stored personal preferences. Only allowlisted keys are exported. A key is absent when the user has never set it; the app then uses the default described on the field, which is not filled in here.

    Show child attributes

    • savedRecordingLanguageCodeSelectionstringoptional

      Recording language the user last chose, as a Vetnio language code (mostly ISO 639-1, such as en or sv; a few longer codes such as yue or fil). Pre-selects the language for new recordings. Absent when never set.

    • savedTranslationLanguageCodeSelectionstringoptional

      Target language the user last chose when translating a document, as a language code from the same list as savedRecordingLanguageCodeSelection. Absent when never set.

    • savedPdfLanguageSelectionstringoptional

      Language the user last chose for PDF exports, which sets the PDF's labels and headings. One of en, sv, de, it, fr, es, pt, no, nl, fi, da. Absent when never set.

    • pdfExportPractitionerobjectoptional

      Practitioner details the user saved in the PDF export dialog, used to prefill the veterinarian block on exported PDFs. Absent when never saved.

      Show child attributes

      • namestringoptional

        Practitioner name, up to 160 characters.

      • emailstringoptional

        Practitioner email address as entered (not verified), up to 254 characters.

    • preferredWorkspaceIdstringoptional

      ID of the workspace (clinic) the user opens by default, for example when launching Vetnio from a practice-management system. Absent when never set; the first workspace the user can access is then used.

    • consultationsPerPagenumberoptional

      Number of consultations shown per page in the consultation list, from 1 to 100. Absent when never set; the default is 10.

    • savedTemplateIdsPerWorkspaceIdobjectoptional

      Template choices remembered per workspace (clinic), keyed by workspace ID. Updated each time the user submits a consultation. Absent when never set.

    • phoneCallConversionSettingsPerWorkspaceIdobjectoptional

      Settings remembered per workspace (clinic), keyed by workspace ID, for turning a phone call into a consultation. Absent when never set.

    • customSystemInstructionGeneralstringoptional

      The user's own instructions, added to every AI-generated document and VetsGPT chat they run. Stored verbatim, up to 50,000 characters. Absent when never set.

    • customSystemInstructionClinicalNotesstringoptional

      The user's own instructions for generating clinical notes, added on top of customSystemInstructionGeneral. Stored verbatim, up to 50,000 characters. Absent when never set.

    • customSystemInstructionCommunicationsstringoptional

      The user's own instructions for generating client communications, added on top of customSystemInstructionGeneral. Stored verbatim, up to 50,000 characters. Absent when never set.

    • customSystemInstructionVetsGPTstringoptional

      The user's own instructions for VetsGPT, the chat assistant, added on top of customSystemInstructionGeneral. Stored verbatim, up to 50,000 characters. Absent when never set.

    • recordingAutoStopSecondsnumberoptionalnullable

      Personal recording auto-stop limit in seconds (60 to 86400). When set, it replaces the workspace's recordingAutoStopSeconds for this user's recordings. null when the user cleared their limit; absent when never set. In both cases the workspace limit applies, or 4 hours if the workspace has none.

    • recordingAutoStopPerSessionbooleanoptionalnullable

      How the personal auto-stop limit is measured. true: the timer restarts each time recording starts or resumes. false: the limit covers all audio recorded in the consultation. Only used together with a personal recordingAutoStopSeconds; null or absent means true.

    • recordingSilenceAlertSoundstringoptional

      Sound played once when no microphone audio has been detected for 20 seconds during a recording:

      • off — no sound
      • chime — gentle chime
      • doubleBeep — double beep
      • bell — bell Absent when never set, which means off.
    • tipsEnabledbooleanoptional

      Whether tips and suggestions are shown while notes are being generated. Absent when never set, which means tips are shown.

    • clinicalNoteGenerationNoticeEnabledbooleanoptional

      Whether a notice is shown when a clinical note starts generating. Absent when never set, which means the notice is shown.

    • manualWritingEnabledbooleanoptional

      Whether the user is offered to write clinical notes, client communications and referral letters themselves instead of recording or generating them. Only applies when the workspace allows it. Absent when never set, which means the option is offered.

    • noteEditorFontSizestringoptional

      Text size in the note editor: small, default, large or xlarge. Display only; it does not change the stored note text. Absent when never set, which means default.

    • noteEditorFontFamilystringoptional

      Typeface in the note editor: default, serif or mono. Display only; it does not change the stored note text. Absent when never set, which means default.

    • copilotModestringoptional

      How VetsGPT applies the note edits it proposes:

      • manual — each change is shown in the note and applied only after the user approves it
      • auto — changes are applied at once and can be undone Absent when never set, which means manual.
    • colorModestringoptional

      App color theme: light or dark. Absent when the user has never chosen a theme.

    • provetExportTargetsstringoptional

      For Provet Cloud users, where exporting a clinical note writes it:

      • clinicalNote — the consultation's clinical note
      • clinicalNoteAndImagingReferral — both the clinical note and the imaging referral
      • imagingReferral — the imaging referral only Absent when never set, which means clinicalNote.
    • provetImagingReferralFieldstringoptional

      Imaging referral field that receives the note when provetExportTargets includes the imaging referral:

      • answer_remarks — the referral's answer remarks
      • diagnosis — the referral's diagnosis Absent when never set, which means answer_remarks.

Errors

400

The request is malformed or failed validation.

401

The API key is missing, invalid or revoked.

403

The key is valid but may not perform this action on this resource.

404

The resource does not exist or is not visible to this key.

500

Something went wrong on Vetnio's side.

Export a workspace's settings and transcription terms

GET/workspaces/{workspaceId}/data-export/content

AcceptsPersonal key

Path parameters

• workspaceIdstringrequired

  Identifier of the workspace (clinic) to export. The caller must be an admin of it, directly or as an admin of its organization.

Returns

• schemaVersionnumberrequired

  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.

  matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

• scopeIdstringrequired

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

• termListobjectrequired

  The scope's current custom transcription vocabulary: names, abbreviations and specialist terms used as spelling and recognition hints. When no list has been saved, terms is empty, version is 0 and updatedAt and updatedBy are null.

  Show child attributes

  • termsarray of stringsrequired

    Terms in their stored spelling and order. Up to 200 terms, each at most 50 characters and four words. Empty when no list is saved.

  • versionintegerrequired

    Edit-concurrency revision of the list: 1 or higher for a saved list, 0 when none is saved. It increases with each save; earlier contents are not retained.

    ≥ 0 · ≤ 9007199254740991

  • updatedAtstring (date-time)requirednullable

    When the list was last saved (ISO 8601, UTC). null when no list is saved.

    matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • updatedBystringrequirednullable

    ID of the user who last saved the list (a UUID). null when no list is saved or that user's account has been deleted.

• inventoryobjectrequired

  Plain-English statements of what this export covers and how to read it, intended for audit records. The wording can change between releases, so do not parse it.

  Show child attributes

  • includedarray of stringsrequired

    Categories of content included in this response.

  • excludedarray of stringsrequired

    Categories deliberately left out of this response, such as credentials, billing identifiers and other owners' settings.

  • limitationsarray of stringsrequired

    How to interpret this export, for example that it contains current values only and is not an atomic snapshot.

• scopeenumrequired

  Exported scope. Always workspace for this endpoint.

• configurationobjectrequired

  Identity, address, shared settings, PIMS department mappings and letterhead image of the workspace (clinic).

  Show child attributes

  • idstringrequired

    ID of the workspace (clinic).

  • namestringrequirednullable

    Clinic display name. null when not set.

  • createdAtstring (date-time)required

    When the workspace was created (ISO 8601, UTC).

    matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • addressstringrequirednullable

    Street address of the clinic. null when not recorded.

  • citystringrequirednullable

    City of the clinic. null when not recorded.

  • stateProvincestringrequirednullable

    State, province or county of the clinic. null when not recorded.

  • zipCodestringrequirednullable

    Postal or ZIP code of the clinic. null when not recorded.

  • countryCodestringrequirednullable

    Two-letter ISO 3166-1 alpha-2 country code of the clinic, as stored (letter case is not normalized). null when not recorded.

  • taxIdstringrequirednullable

    Tax identification number of the clinic, such as a VAT number. null when not recorded.

  • phonestringrequirednullable

    Clinic phone number, as entered. null when not recorded.

  • allowPasswordsbooleanrequired

    Stored value of the workspace's allow-passwords flag. true unless it has been changed.

  • templatePermissionsstringrequired

    What members (non-admins) can do with templates:

    • full_access — view, use and edit templates created by other members (the default)
    • view_only — view and use templates created by others, but not edit them
    • private — edit only their own templates, and view only templates created by admins
    • strict — only view and use templates created by admins; members cannot create templates
  • audioFileRetentionPeriodInDaysintegerrequirednullable

    Audio retention period in days set on this workspace. Consultation and meeting recordings older than this are deleted automatically. When linked organizations also set a period, the shortest one applies; export each organization to see its period. null when the workspace has no period of its own.

    ≥ -9007199254740991 · ≤ 9007199254740991

  • isMeetingsEnabledbooleanrequired

    Whether the meetings feature (recording meetings with automatic note generation) is switched on for the workspace.

  • manualPimsKindstringrequirednullable

    Practice-management system (PIMS) the clinic uses, recorded by Vetnio staff when no connected integration shows it. It takes precedence over detection:

    • provet — Provet Cloud
    • link — Link
    • animana — Animana
    • vetmanager — VetManager
    • fuga — Fuga
    • other — another system, named in manualPimsName
    • none — no PIMS null when not recorded.
  • manualPimsNamestringrequirednullable

    Name of the practice-management system when manualPimsKind is other. null otherwise.

  • settingsobjectrequired

    The workspace's stored shared settings. Only allowlisted keys are exported; credentials, provider connection details and internal state are left out. A key is absent when it has never been set; the default described on each field then applies and is not filled in here.

    Show child attributes

    • consultationVisibilitystringoptional

      Whether members can list consultations created by others:

      • creator — each member's consultation list shows only their own consultations
      • workspace — members can filter the list to show colleagues' or everyone's consultations Absent when never set, which behaves as creator. This affects listing only; any workspace member can open an individual consultation either way.
    • dateFormatstringoptional

      Date format the AI uses when writing dates in generated documents: YYYY-MM-DD, DD-MM-YYYY or MM-DD-YYYY. Absent when never set, which means YYYY-MM-DD.

    • documentHeaderobjectoptional

      A short notice placed at the top of AI-generated documents of the selected types. Absent when never configured, which means no header.

      Show child attributes

      • headerTypestringrequired

        Which header text is used. Preset texts are written in the document's language:

        • none — no header
        • preset_1 — states that the document was generated with AI assistance and reviewed by a veterinary professional
        • preset_2 — marks the document as a confidential veterinary medical record
        • preset_3 — states that the document is AI-generated and that clinical details should be verified before use
        • custom — the text in customText
      • customTextstringoptional

        Header text used when headerType is custom, up to 500 characters. Inserted as plain text. Absent when not set.

      • enabledDocumentTypesarray of stringsrequired

        Document types that receive the header. An empty array means no document receives it.

    • pdfExportClinicDetailsobjectoptional

      Clinic details saved from the PDF export dialog and used to prefill the clinic block on exported PDFs. Shared by all members of the workspace. Absent when never saved; empty fields are omitted.

      Show child attributes

      • clinicstringoptional

        Clinic name to print, up to 500 characters.

      • addressstringoptional

        Clinic address to print, up to 500 characters.

      • zipCodestringoptional

        Postal or ZIP code to print, up to 500 characters.

      • phonestringoptional

        Clinic phone number to print, as entered, up to 500 characters.

    • pdfLetterheadobjectoptional

      Letterhead layout for PDF exports of clinical notes and meeting notes. Absent when never configured, which means PDFs have no letterhead. The uploaded logo itself is exported in configuration.letterheadAsset.

      Show child attributes

      • templateIdstringrequired

        Letterhead layout. Current layouts: clean-letterhead (the default), sidebar-summary, centered-letterhead, teal-band. Older layouts that are still supported: logo-left, banner-above, logo-centered. Unknown values are rendered as clean-letterhead.

      • enabledbooleanoptional

        false when the letterhead has been switched off; the other settings are kept. Absent or true means the letterhead is used.

      • includeClinicInfobooleanoptional

        Whether the clinic information block is printed on PDFs. Absent means true.

      • fontIdstringoptional

        Typeface for PDF text: system-sans, humanist-sans, classic-serif or document-serif. Absent means system-sans.

      • logoFitstringoptional

        How the logo is scaled into its area:

        • contain — the whole logo is shown, keeping its proportions (the default when absent)
        • cover — the logo fills the area, keeping its proportions; edges may be cropped
        • fill — the logo is stretched to the area
      • accentColorstringoptional

        Accent color as a hex code (#rgb or #rrggbb). Absent when never set; the default is #3d838b.

    • globalTemplateInstructionsobjectoptional

      Instructions the workspace adds to AI-generated documents on top of the chosen template. general applies to every document type; the other fields are added for their own document type only. Stored verbatim. Absent when never set.

      Show child attributes

      • generalstringoptional

        Instructions added to every AI-generated document, up to 4,000 characters. Absent when never set.

      • clinicalNotestringoptional

        Instructions added when generating clinical notes, up to 4,000 characters. Absent when never set.

      • referralstringoptional

        Instructions added when generating referrals, up to 4,000 characters. Absent when never set.

      • communicationstringoptional

        Instructions added when generating client communications, up to 4,000 characters. Absent when never set.

    • patientMatchingEnabledbooleanoptional

      Whether Vetnio looks for a matching patient record after a consultation's clinical note is generated, so it can be linked to that patient. Absent when never set, which means off.

    • aiTitlesEnabledbooleanoptional

      Workspace setting for AI-generated consultation titles, written from the clinical note after it is saved. true or false takes precedence over the organization setting. Absent when never set at workspace level; titles are then generated only if a linked organization enables them (aiTitlesEnabled in its organization export).

    • aiTitlesUseAsNamebooleanoptional

      Whether an automatically generated title fills an unnamed consultation's name instead of appearing separately. Existing consultation names are preserved. Absent means false.

    • aiTitlesNamingStyleenumoptional

      Automatic consultation naming style: patient name and case information, case information only, or custom instructions. Absent means case_only.

      Possible values:patient_and_casecase_onlycustom

    • aiTitlesCustomPromptstringoptional

      Custom instructions for automatic consultation names, used when aiTitlesNamingStyle is custom. Up to 1,000 characters. Absent when never set.

    • recordingAutoStopSecondsnumberoptional

      Workspace recording auto-stop limit in seconds (60 to 86400). Applies to members who have no personal limit. Absent when never set or cleared; the default of 4 hours then applies.

    • recordingViewenumoptional

      Recording display: waveform animation or a pre-visit briefing with a small recording indicator. An explicit workspace value overrides organization defaults. When absent, briefing is used if any linked organization selects it; otherwise waveform.

      Possible values:waveformbriefing

    • liveTranscriptionEnabledbooleanoptional

      Whether live transcription starts with consultation recording. An explicit workspace value overrides organization defaults. When absent, live transcription is disabled if any linked organization disables it; otherwise enabled. Audio recording and transcription after recording are unaffected.

    • recordingAutoStopPerSessionbooleanoptional

      How the workspace auto-stop limit is measured. true: the timer restarts each time recording starts or resumes. false: the limit covers all audio recorded in the consultation. Absent means true.

    • recordingConcurrencyControlobjectoptional

      Limits on simultaneous recordings in the workspace. Absent when never configured, which means no limit.

      Show child attributes

      • enabledbooleanoptional

        Whether the limit is enforced. When true, the number of recordings active at the same time in the workspace is capped at its number of licensed seats (no cap during a trial or when no seat count is set). Absent means false.

      • limitActiveRecordingsPerUserbooleanoptional

        When true and enabled is true, each user can have only one active recording at a time. Absent means false.

      • heartbeatTimeoutSecondsnumberoptional

        Seconds without a signal from the recording device after which an active recording no longer counts toward the limit. Values are clamped to 10 to 120 when applied; absent means 90.

    • phoneCallIntegrationEnabledbooleanoptional

      Whether a phone-call integration is switched on for the workspace. Used to show phone-call features, such as importing a call into the practice-management system from the browser extension. Absent means false.

    • telephonyEnabledbooleanoptional

      Whether telephony is switched on for the workspace. With phoneProvider telnyx_webrtc it enables outbound calls from Vetnio's built-in phone; with starface it enables call import. Absent means false.

    • phoneProviderstringoptional

      Phone system the workspace's calls come from:

      • telnyx_webrtc — Vetnio's built-in browser phone
      • telavox — Telavox
      • nightcall — Nightcall
      • 3cx — 3CX
      • xelion — Xelion
      • starface — STARFACE Absent when no provider has been selected.
    • phoneCallSpellingCorrectionobjectoptional

      AI spelling correction applied to phone-call transcripts. Absent when never configured, which means correction is on with no extra context.

      Show child attributes

      • enabledbooleanoptional

        false turns AI spelling correction of phone-call transcripts off. Absent means on.

      • employeeNamesarray of stringsoptional

        Staff names the correction should spell correctly. Absent when never set; an empty array means none.

      • additionalContextstringoptional

        Free-text context given to the correction, for example product or place names. Absent when never set; an empty string means none.

    • phoneCallSummaryStyleobjectoptional

      Format of AI summaries of phone calls. Absent when never set, which means paragraph and medium.

      Show child attributes

      • formatstringoptional

        Layout of the summary:

        • paragraph — flowing prose (the default when absent)
        • bullets — a bulleted list
      • verbositystringoptional

        Length of the summary:

        • short — about 1 to 2 sentences, or 2 to 3 bullets
        • medium — about 3 to 5 sentences, or 4 to 6 bullets (the default when absent)
        • long — about 6 to 10 sentences, or 7 to 12 bullets
    • provetPhoneCallsobjectoptional

      Settings for drafting notes and tasks from phone calls and saving them to Provet Cloud. Absent when never configured.

      Show child attributes

      • enabledbooleanoptional

        Whether drafting phone-call documentation and saving it to Provet Cloud is switched on.

      • providerIdstringoptional

        ID of the workspace's Provet Cloud connection in Vetnio, used to look up clients and save notes and tasks. Empty string when none is selected.

      • departmentIdnumberoptional

        Provet Cloud department ID used when saving notes and tasks. Absent when not set.

      • templatesTextstringoptional

        Phone-documentation templates as one text. Each template starts with a ## <name> heading line followed by its body. Up to 25 templates and 60,000 characters.

      • routingInstructionsstringoptional

        Free-text rules the AI follows when choosing a template for a call, up to 12,000 characters.

      • timeZonestringoptional

        IANA time zone used for the night window and for call times shown to the AI. The default is Europe/Stockholm.

      • nightobjectoptional

        Requires one template for calls that start inside a nightly time window. Absent when not configured.

        Show child attributes

        • startHournumberrequired

          Hour (0 to 23, in timeZone) at which the night window starts, inclusive.

        • endHournumberrequired

          Hour (0 to 23, in timeZone) at which the night window ends, exclusive. Lower than startHour when the window spans midnight.

        • templateNamestringrequired

          Name of the template (a ## heading in templatesText) that must be used for calls that start in the window.

    • provetExportModestringoptional

      Legacy stored preference, ignored by exports. All billing items are added as consultation items through Provet Cloud's per-type endpoints and billed when the consultation is finalized.

    • revenueRecoveryEnabledbooleanoptional

      Whether Revenue Recovery, which suggests billable items from the consultation for the practice-management system invoice, is switched on. Absent means false.

    • revenueRecoverySuggestionPolicyobjectoptional

      Rules for which billable items Revenue Recovery suggests. Absent when never configured, which means bundles first, no excluded categories and no required billing lines.

      Show child attributes

      • bundlePolicystringoptional

        How Revenue Recovery treats Provet Cloud bundles:

        • bundles_first — prefer matching bundles over their individual items (the default)
        • items_first — prefer individual items; suggest a bundle only when it matches the service almost exactly
        • hide_bundles — never suggest bundles
      • excludedCategoriesarray of stringsoptional

        Catalog categories that are never suggested: procedure, medication, equipment, retail, lab. Exported as stored; the older values food and protocol are treated as retail and procedure.

      • searchHiddenCategoriesarray of stringsoptional

        Catalog categories also hidden from the invoice builder's manual search, using the same values as excludedCategories. A hidden category is never suggested either. Absent on policies saved before this setting existed, which hide every excluded category.

      • requiredCategoriesarray of objectsoptional

        Billing lines the clinic defined explicitly, such as a consultation fee. Up to 20.

        Show child attributes

        • idstringrequired

          Identifier of the billing line, unique within the policy (up to 64 characters).

        • labelstringrequired

          Display name of the billing line (up to 80 characters).

        • instructionstringoptional

          The clinic's instruction for choosing between the items, up to 600 characters.

        • rulestringoptional

          When the line is suggested:

          • always_one — on every consultation, with exactly one item chosen (the default)
          • when_relevant — only when the consultation supports it
        • itemIdsarray of stringsrequired

          Catalog item IDs that can fill this line (1 to 12).

    • aiReceptionistobjectoptional

      Configuration of the clinic's AI receptionist, which can book appointments in the practice-management system. Absent when never configured. Practice-system connection details and provider identifiers are not exported.

      Show child attributes

      • enabledbooleanoptional

        Whether the AI receptionist is switched on.

      • defaultLocalestringoptional

        Default language of the AI receptionist: en or sv-SE.

      • timeZonestringoptional

        IANA time zone of the clinic, used for appointment times.

      • emergencyPhonestringoptionalnullable

        Emergency phone number configured for the AI receptionist, as entered. null when explicitly cleared; absent when never set.

      • pimsKindstringoptional

        Practice-management system the AI receptionist books appointments in: none, link or provet.

      • bookingConfigobjectoptional

        Booking rules for the AI receptionist. Absent when never set.

        Show child attributes

        • minimumNoticeMinutesnumberoptional

          Minimum time in minutes between the moment of booking and the start of a bookable slot. Absent when not set.

    • schedulingEnabledbooleanoptional

      Whether the staff scheduler (for admins) and Vetnio's own appointment book (for every member) are available. Absent means false.

    • provetScheduleEnabledbooleanoptional

      Whether members see their Provet appointments in the calendar, read-only and independently of schedulingEnabled. Absent means false.

    • personalizationsDisabledbooleanoptional

      true when personalization is switched off for the whole workspace: Vetnio then neither learns from members' note edits nor applies learned writing style. Absent or false means personalization is on, unless it is switched off for an individual user.

    • manualWritingEnabledbooleanoptional

      Whether members are offered to write clinical notes, client communications and referral letters themselves instead of recording or generating them. Set by Vetnio. Absent means false.

    • saveAnimanaPatientsbooleanoptional

      Whether patient details from Animana are saved to Vetnio when a consultation is started from Animana. Absent means true.

  • pimsDepartmentMappingsarray of objectsrequired

    Practice-management system departments linked to this workspace. When a user opens Vetnio from a linked Provet Cloud department, this workspace is opened. Ordered by instanceId, then departmentId. Empty when there are none.

    Show child attributes

    • instanceIdstringrequired

      ID of the practice-management system instance, for example a Provet Cloud instance number.

    • departmentIdstringrequired

      Department ID within that instance, as a numeric string.

    • createdAtstring (date-time)required

      When the mapping was created (ISO 8601, UTC).

      matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

    • updatedAtstring (date-time)required

      When the mapping was last changed (ISO 8601, UTC).

      matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • catalogSwitchesobjectoptional

    Suggest and Search switches for catalog items and bundles. Absent when the workspace has none.

    Show child attributes

    • itemsarray of objectsrequired

      Item switches, ordered by itemId. Empty when there are none.

      Show child attributes

      • itemIdstringrequired

        ID of the canonical catalog item.

      • suggestenumrequirednullable

        Whether Revenue Recovery may suggest it: on, off, or null to follow the category default.

      • searchenumrequirednullable

        Whether vets can find it in the invoice builder's manual search: on, off, or null to follow the category default.

    • bundlesarray of objectsrequired

      Bundle switches, ordered by bundleId. Empty when there are none.

      Show child attributes

      • bundleIdstringrequired

        ID of the catalog bundle.

      • sourceTemplateIdstringrequirednullable

        ID of the bundle's template in the practice-management system. null when it is not known.

      • suggestenumrequirednullable

        Whether Revenue Recovery may suggest it: on, off, or null to follow the category default.

      • searchenumrequirednullable

        Whether vets can find it in the invoice builder's manual search: on, off, or null to follow the category default.

  • catalogNotesobjectoptional

    Notes for Vetnio on catalog items and bundles. Absent when the workspace has none.

    Show child attributes

    • itemsarray of objectsrequired

      Item notes, ordered by itemId. Empty when there are none.

      Show child attributes

      • itemIdstringrequired

        ID of the canonical catalog item.

      • descriptionstringrequired

        The note as the clinic or Vetnio wrote it (at most 500 characters).

      • updatedAtstringrequired

        When the note was last changed (ISO 8601, UTC).

    • bundlesarray of objectsrequired

      Bundle notes, ordered by bundleId. Empty when there are none.

      Show child attributes

      • bundleIdstringrequired

        ID of the catalog bundle.

      • sourceTemplateIdstringrequirednullable

        ID of the bundle's template in the practice-management system. null when it is not known.

      • descriptionstringrequired

        The note as the clinic or Vetnio wrote it (at most 500 characters).

      • updatedAtstringrequired

        When the note was last changed (ISO 8601, UTC).

  • letterheadAssetobjectrequirednullable

    The workspace's uploaded letterhead logo, re-encoded as PNG and scaled down to fit within 1800 x 900 pixels (at most 2 MB). Included even when the letterhead is switched off. null when no logo is configured.

    Show child attributes

    • mimeTypeenumrequired

      Media type of content. Always image/png.

    • encodingenumrequired

      Encoding of content. Always base64.

    • contentstringrequired

      The PNG file, base64-encoded (standard alphabet with padding).

Errors

400

The request is malformed or failed validation.

401

The API key is missing, invalid or revoked.

403

The key is valid but may not perform this action on this resource.

404

The resource does not exist or is not visible to this key.

500

Something went wrong on Vetnio's side.

Export a workspace's structured (JSON) templates

GET/workspaces/{workspaceId}/data-export/json-templates

AcceptsPersonal key

Path parameters

• workspaceIdstringrequired

  Identifier of the workspace (clinic) to export. The caller must be an admin of it, directly or as an admin of its organization.

Query parameters

• cursorstringoptional

  Pagination cursor: the nextCursor value from the previous page. Omit for the first page, and keep the same owner and template category while paging. Items with an ID greater than the cursor are returned.

  at least 1 characters · at most 512 characters

• limitintegeroptional

  Maximum number of templates per page, 1-50.

  Default 20 · ≥ 1 · ≤ 50

Returns

• nextCursorstringrequirednullable

  Pass this value as cursor to fetch the next page. null when this is the last page.

• expiresInSecondsnumberrequired

  Lifetime of every contentUrl on this page, in seconds.

• expiresAtstring (date-time)required

  When the contentUrl links on this page stop working (ISO-8601 UTC). Download before then. Expiry does not affect the stored content.

  matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

• itemsarray of objectsrequired

  JSON templates on this page, ordered by ascending ID.

  Show child attributes

  • idstringrequired

    JSON template ID. Note templates refer to it through jsonTemplateId.

  • workspaceIdstringrequired

    ID of the workspace (clinic) that owns the template.

  • namestringrequirednullable

    Schema name shown in the app, or null if it was never named.

  • creatorIdstringrequired

    User ID (UUID) of the person who created the template.

  • createdAtstring (date-time)required

    When the template was created (ISO-8601 UTC).

    matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • artifactobjectrequirednullable

    Download of the schema in its original JSON form, or null when no stored body exists.

    Show child attributes

    • contentUrlstringrequired

      Signed HTTPS URL that downloads the stored body without further authentication. It expires at the page's expiresAt (one hour); fetch the page again for a fresh link. Treat it as a secret.

    • currentVersionIdstringrequirednullable

      The downloaded version. Null means storage supplied no immutable version ID, including the legacy null version, so the URL follows the current object.

    • contentTypestringrequirednullable

      Media type of the stored body as recorded by storage, for example text/html or application/json, or null if none was recorded.

    • sizenumberrequirednullable

      Size of the stored body in bytes, or null if unknown.

    • lastModifiedstring (date-time)requirednullable

      When the current body was last written (ISO-8601 UTC), or null if unknown.

      matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

Errors

400

The request is malformed or failed validation.

401

The API key is missing, invalid or revoked.

403

The key is valid but may not perform this action on this resource.

404

The resource does not exist or is not visible to this key.

500

Something went wrong on Vetnio's side.

Get a retained version of a workspace JSON template

GET/workspaces/{workspaceId}/data-export/json-templates/version

AcceptsPersonal key

Path parameters

• workspaceIdstringrequired

  Identifier of the workspace (clinic) to export. The caller must be an admin of it, directly or as an admin of its organization.

Query parameters

• partenumoptional

  Which stored object of the template to read:

  • content — the template body itself.
  • instructions — the separate instructions object of an imported template (original wording and per-section instructions). Only workspace note and meeting templates have one; other kinds return 400.

  Default content

• templateIdstringrequired

  ID of the template, as returned in items[].id by the matching template export. It must belong to the workspace or organization in the path, otherwise 404.

  at least 1 characters · at most 512 characters

• versionIdstringrequired

  Opaque version ID from the versions list (versions[].versionId) or from artifact.currentVersionId. URL-encode it; it can contain characters such as +, / and =.

  at least 1 characters · at most 2048 characters

Returns

• currentVersionIdstringrequirednullable

  Version ID of the template's current body at the time of the request, or null when there is no current body. Unlike artifact.currentVersionId, a legacy unversioned body is reported here as the literal string "null".

• versionobjectrequired

  Metadata of the requested version.

  Show child attributes

  • versionIdstringrequired

    Opaque stored version ID. A literal null version belongs to unversioned or suspended storage and can be overwritten.

  • isLatestbooleanrequired

    true when this version is the template's current body.

  • lastModifiedstring (date-time)requirednullable

    When this version was stored (ISO-8601 UTC), or null if unknown.

    matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • sizenumberrequirednullable

    Size of this version's body in bytes, or null if unknown.

  • contentTypestringrequirednullable

    Media type of this version's body as recorded by storage, for example text/html or application/json, or null.

  • auditobjectrequirednullable

    Audit details of the edit that saved this version. Only available for workspace note templates and part=content; null otherwise, or when no matching audit entry exists. Not a clinical approval or accuracy classification.

    Show child attributes

    • idstringrequired

      ID of the audit-log entry (UUID).

    • occurredAtstring (date-time)required

      When the change was made (ISO-8601 UTC).

      matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

    • actorNamestringrequirednullable

      Display name of the person who made the change, or null when unknown or for system changes. For changes made by Vetnio support on a customer's behalf, this is the support staff member.

    • actorTypeenumrequired

      Who made the change:

      • user — a member of the customer's team.
      • vetnio_staff — Vetnio staff, for example while providing support.
      • system — an automated process.
    • actionstringrequired

      Audit action that saved this version, for example template.created, template.content_updated or template.restored.

    • s3VersionIdstringrequired

      The stored version ID the audit entry refers to; equals the version's versionId.

• contentstringrequired

  The exact retained body as UTF-8 text, including HTML instructions or the original JSON schema.

Errors

400

The request is malformed or failed validation.

401

The API key is missing, invalid or revoked.

403

The key is valid but may not perform this action on this resource.

404

The resource does not exist or is not visible to this key.

500

Something went wrong on Vetnio's side.

List retained versions of a workspace JSON template

GET/workspaces/{workspaceId}/data-export/json-templates/versions

AcceptsPersonal key

Path parameters

• workspaceIdstringrequired

  Identifier of the workspace (clinic) to export. The caller must be an admin of it, directly or as an admin of its organization.

Query parameters

• partenumoptional

  Which stored object of the template to read:

  • content — the template body itself.
  • instructions — the separate instructions object of an imported template (original wording and per-section instructions). Only workspace note and meeting templates have one; other kinds return 400.

  Default content

• templateIdstringrequired

  ID of the template, as returned in items[].id by the matching template export. It must belong to the workspace or organization in the path, otherwise 404.

  at least 1 characters · at most 512 characters

• cursorstringoptional

  Opaque pagination cursor: the nextCursor value from the previous page of this template's versions. Omit for the first page. URL-encode it.

  at least 1 characters · at most 2048 characters

Returns

• currentVersionIdstringrequirednullable

  Version ID of the template's current body at the time of the request, or null when there is no current body. Unlike artifact.currentVersionId, a legacy unversioned body is reported here as the literal string "null".

• versionsarray of objectsrequired

  Retained versions on this page, newest first. A page can hold fewer than 50 versions even when more follow.

  Show child attributes

  • versionIdstringrequired

    Opaque stored version ID. A literal null version belongs to unversioned or suspended storage and can be overwritten.

  • isLatestbooleanrequired

    true when this version is the template's current body.

  • lastModifiedstring (date-time)requirednullable

    When this version was stored (ISO-8601 UTC), or null if unknown.

    matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • sizenumberrequirednullable

    Size of this version's body in bytes, or null if unknown.

  • auditobjectrequirednullable

    Audit details of the edit that saved this version. Only available for workspace note templates and part=content; null otherwise, or when no matching audit entry exists. Not a clinical approval or accuracy classification.

    Show child attributes

    • idstringrequired

      ID of the audit-log entry (UUID).

    • occurredAtstring (date-time)required

      When the change was made (ISO-8601 UTC).

      matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

    • actorNamestringrequirednullable

      Display name of the person who made the change, or null when unknown or for system changes. For changes made by Vetnio support on a customer's behalf, this is the support staff member.

    • actorTypeenumrequired

      Who made the change:

      • user — a member of the customer's team.
      • vetnio_staff — Vetnio staff, for example while providing support.
      • system — an automated process.
    • actionstringrequired

      Audit action that saved this version, for example template.created, template.content_updated or template.restored.

    • s3VersionIdstringrequired

      The stored version ID the audit entry refers to; equals the version's versionId.

• nextCursorstringrequirednullable

  Pass this value as cursor to fetch older versions. null when the history is complete.

Errors

400

The request is malformed or failed validation.

401

The API key is missing, invalid or revoked.

403

The key is valid but may not perform this action on this resource.

404

The resource does not exist or is not visible to this key.

500

Something went wrong on Vetnio's side.

Export a workspace's meeting templates

GET/workspaces/{workspaceId}/data-export/meeting-templates

AcceptsPersonal key

Path parameters

• workspaceIdstringrequired

  Identifier of the workspace (clinic) to export. The caller must be an admin of it, directly or as an admin of its organization.

Query parameters

• cursorstringoptional

  Pagination cursor: the nextCursor value from the previous page. Omit for the first page, and keep the same owner and template category while paging. Items with an ID greater than the cursor are returned.

  at least 1 characters · at most 512 characters

• limitintegeroptional

  Maximum number of templates per page, 1-50.

  Default 20 · ≥ 1 · ≤ 50

Returns

• nextCursorstringrequirednullable

  Pass this value as cursor to fetch the next page. null when this is the last page.

• expiresInSecondsnumberrequired

  Lifetime of every contentUrl on this page, in seconds.

• expiresAtstring (date-time)required

  When the contentUrl links on this page stop working (ISO-8601 UTC). Download before then. Expiry does not affect the stored content.

  matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

• itemsarray of objectsrequired

  Meeting templates on this page, ordered by ascending ID.

  Show child attributes

  • idstringrequired

    Meeting template ID.

  • workspaceIdstringrequired

    ID of the workspace (clinic) that owns the template.

  • namestringrequired

    Template name shown in the app.

  • creatorIdstringrequired

    User ID (UUID) of the person who created the template.

  • createdAtstring (date-time)required

    When the template was created (ISO-8601 UTC).

    matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • artifactobjectrequirednullable

    Download of the template body, or null when no stored body exists.

    Show child attributes

    • contentUrlstringrequired

      Signed HTTPS URL that downloads the stored body without further authentication. It expires at the page's expiresAt (one hour); fetch the page again for a fresh link. Treat it as a secret.

    • currentVersionIdstringrequirednullable

      The downloaded version. Null means storage supplied no immutable version ID, including the legacy null version, so the URL follows the current object.

    • contentTypestringrequirednullable

      Media type of the stored body as recorded by storage, for example text/html or application/json, or null if none was recorded.

    • sizenumberrequirednullable

      Size of the stored body in bytes, or null if unknown.

    • lastModifiedstring (date-time)requirednullable

      When the current body was last written (ISO-8601 UTC), or null if unknown.

      matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • instructionsArtifactobjectrequirednullable

    Download of the imported template's separate instructions object, or null when there is none.

    Show child attributes

    • contentUrlstringrequired

      Signed HTTPS URL that downloads the stored body without further authentication. It expires at the page's expiresAt (one hour); fetch the page again for a fresh link. Treat it as a secret.

    • currentVersionIdstringrequirednullable

      The downloaded version. Null means storage supplied no immutable version ID, including the legacy null version, so the URL follows the current object.

    • contentTypestringrequirednullable

      Media type of the stored body as recorded by storage, for example text/html or application/json, or null if none was recorded.

    • sizenumberrequirednullable

      Size of the stored body in bytes, or null if unknown.

    • lastModifiedstring (date-time)requirednullable

      When the current body was last written (ISO-8601 UTC), or null if unknown.

      matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

Errors

400

The request is malformed or failed validation.

401

The API key is missing, invalid or revoked.

403

The key is valid but may not perform this action on this resource.

404

The resource does not exist or is not visible to this key.

500

Something went wrong on Vetnio's side.

Get a retained version of a workspace meeting template

GET/workspaces/{workspaceId}/data-export/meeting-templates/version

AcceptsPersonal key

Path parameters

• workspaceIdstringrequired

  Identifier of the workspace (clinic) to export. The caller must be an admin of it, directly or as an admin of its organization.

Query parameters

• partenumoptional

  Which stored object of the template to read:

  • content — the template body itself.
  • instructions — the separate instructions object of an imported template (original wording and per-section instructions). Only workspace note and meeting templates have one; other kinds return 400.

  Default content

• templateIdstringrequired

  ID of the template, as returned in items[].id by the matching template export. It must belong to the workspace or organization in the path, otherwise 404.

  at least 1 characters · at most 512 characters

• versionIdstringrequired

  Opaque version ID from the versions list (versions[].versionId) or from artifact.currentVersionId. URL-encode it; it can contain characters such as +, / and =.

  at least 1 characters · at most 2048 characters

Returns

• currentVersionIdstringrequirednullable

  Version ID of the template's current body at the time of the request, or null when there is no current body. Unlike artifact.currentVersionId, a legacy unversioned body is reported here as the literal string "null".

• versionobjectrequired

  Metadata of the requested version.

  Show child attributes

  • versionIdstringrequired

    Opaque stored version ID. A literal null version belongs to unversioned or suspended storage and can be overwritten.

  • isLatestbooleanrequired

    true when this version is the template's current body.

  • lastModifiedstring (date-time)requirednullable

    When this version was stored (ISO-8601 UTC), or null if unknown.

    matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • sizenumberrequirednullable

    Size of this version's body in bytes, or null if unknown.

  • contentTypestringrequirednullable

    Media type of this version's body as recorded by storage, for example text/html or application/json, or null.

  • auditobjectrequirednullable

    Audit details of the edit that saved this version. Only available for workspace note templates and part=content; null otherwise, or when no matching audit entry exists. Not a clinical approval or accuracy classification.

    Show child attributes

    • idstringrequired

      ID of the audit-log entry (UUID).

    • occurredAtstring (date-time)required

      When the change was made (ISO-8601 UTC).

      matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

    • actorNamestringrequirednullable

      Display name of the person who made the change, or null when unknown or for system changes. For changes made by Vetnio support on a customer's behalf, this is the support staff member.

    • actorTypeenumrequired

      Who made the change:

      • user — a member of the customer's team.
      • vetnio_staff — Vetnio staff, for example while providing support.
      • system — an automated process.
    • actionstringrequired

      Audit action that saved this version, for example template.created, template.content_updated or template.restored.

    • s3VersionIdstringrequired

      The stored version ID the audit entry refers to; equals the version's versionId.

• contentstringrequired

  The exact retained body as UTF-8 text, including HTML instructions or the original JSON schema.

Errors

400

The request is malformed or failed validation.

401

The API key is missing, invalid or revoked.

403

The key is valid but may not perform this action on this resource.

404

The resource does not exist or is not visible to this key.

500

Something went wrong on Vetnio's side.

List retained versions of a workspace meeting template

GET/workspaces/{workspaceId}/data-export/meeting-templates/versions

AcceptsPersonal key

Path parameters

• workspaceIdstringrequired

  Identifier of the workspace (clinic) to export. The caller must be an admin of it, directly or as an admin of its organization.

Query parameters

• partenumoptional

  Which stored object of the template to read:

  • content — the template body itself.
  • instructions — the separate instructions object of an imported template (original wording and per-section instructions). Only workspace note and meeting templates have one; other kinds return 400.

  Default content

• templateIdstringrequired

  ID of the template, as returned in items[].id by the matching template export. It must belong to the workspace or organization in the path, otherwise 404.

  at least 1 characters · at most 512 characters

• cursorstringoptional

  Opaque pagination cursor: the nextCursor value from the previous page of this template's versions. Omit for the first page. URL-encode it.

  at least 1 characters · at most 2048 characters

Returns

• currentVersionIdstringrequirednullable

  Version ID of the template's current body at the time of the request, or null when there is no current body. Unlike artifact.currentVersionId, a legacy unversioned body is reported here as the literal string "null".

• versionsarray of objectsrequired

  Retained versions on this page, newest first. A page can hold fewer than 50 versions even when more follow.

  Show child attributes

  • versionIdstringrequired

    Opaque stored version ID. A literal null version belongs to unversioned or suspended storage and can be overwritten.

  • isLatestbooleanrequired

    true when this version is the template's current body.

  • lastModifiedstring (date-time)requirednullable

    When this version was stored (ISO-8601 UTC), or null if unknown.

    matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • sizenumberrequirednullable

    Size of this version's body in bytes, or null if unknown.

  • auditobjectrequirednullable

    Audit details of the edit that saved this version. Only available for workspace note templates and part=content; null otherwise, or when no matching audit entry exists. Not a clinical approval or accuracy classification.

    Show child attributes

    • idstringrequired

      ID of the audit-log entry (UUID).

    • occurredAtstring (date-time)required

      When the change was made (ISO-8601 UTC).

      matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

    • actorNamestringrequirednullable

      Display name of the person who made the change, or null when unknown or for system changes. For changes made by Vetnio support on a customer's behalf, this is the support staff member.

    • actorTypeenumrequired

      Who made the change:

      • user — a member of the customer's team.
      • vetnio_staff — Vetnio staff, for example while providing support.
      • system — an automated process.
    • actionstringrequired

      Audit action that saved this version, for example template.created, template.content_updated or template.restored.

    • s3VersionIdstringrequired

      The stored version ID the audit entry refers to; equals the version's versionId.

• nextCursorstringrequirednullable

  Pass this value as cursor to fetch older versions. null when the history is complete.

Errors

400

The request is malformed or failed validation.

401

The API key is missing, invalid or revoked.

403

The key is valid but may not perform this action on this resource.

404

The resource does not exist or is not visible to this key.

500

Something went wrong on Vetnio's side.

Export a workspace's note templates

GET/workspaces/{workspaceId}/data-export/templates

AcceptsPersonal key

Path parameters

• workspaceIdstringrequired

  Identifier of the workspace (clinic) to export. The caller must be an admin of it, directly or as an admin of its organization.

Query parameters

• cursorstringoptional

  Pagination cursor: the nextCursor value from the previous page. Omit for the first page, and keep the same owner and template category while paging. Items with an ID greater than the cursor are returned.

  at least 1 characters · at most 512 characters

• limitintegeroptional

  Maximum number of templates per page, 1-50.

  Default 20 · ≥ 1 · ≤ 50

Returns

• nextCursorstringrequirednullable

  Pass this value as cursor to fetch the next page. null when this is the last page.

• expiresInSecondsnumberrequired

  Lifetime of every contentUrl on this page, in seconds.

• expiresAtstring (date-time)required

  When the contentUrl links on this page stop working (ISO-8601 UTC). Download before then. Expiry does not affect the stored content.

  matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

• itemsarray of objectsrequired

  Templates on this page, ordered by ascending ID.

  Show child attributes

  • idstringrequired

    Template ID. Pass it as templateId to the versions endpoints.

  • workspaceIdstringrequired

    ID of the workspace (clinic) that owns the template.

  • namestringrequirednullable

    Template name shown in the app, or null if it was never named.

  • typeenumrequired

    What the template produces:

    • clinical_note — the clinical note (medical record entry) for a consultation.
    • referral — a referral letter to another clinic or specialist.
    • client_communication — a message to the pet owner.
  • creatorIdstringrequired

    User ID (UUID) of the person who created the template.

  • creatorRoleenumrequired

    Workspace role the creator had when creating the template:

    • member — clinician.
    • admin — workspace administrator.
    • superadmin — workspace owner-level administrator.
  • createdAtstring (date-time)required

    When the template was created (ISO-8601 UTC).

    matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • updatedAtstring (date-time)requirednullable

    When the template was last changed (ISO-8601 UTC), or null if never changed after creation.

    matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • updatedBystringrequirednullable

    User ID of the person who last changed the template, or null.

  • isManagedbooleanrequired

    true when Vetnio or the clinic's organization provisioned the template (for example from an organization template or an integration) rather than a clinic user writing it.

  • isDefaultenumrequired

    Always false: Vetnio's read-only default catalog templates are excluded from this export.

  • jsonTemplateIdstringrequirednullable

    Linked JSON template ID only when the schema belongs to this workspace and is included in its JSON template export.

  • hasExcludedJsonTemplatebooleanrequired

    true when the template links to a structured (JSON) schema that is not part of this workspace's export, such as a Vetnio-provided schema. That schema's ID and body are not exposed.

  • instructionsArtifactobjectrequirednullable

    Stored imported-template instructions and section strategies, when present.

    Show child attributes

    • contentUrlstringrequired

      Signed HTTPS URL that downloads the stored body without further authentication. It expires at the page's expiresAt (one hour); fetch the page again for a fresh link. Treat it as a secret.

    • currentVersionIdstringrequirednullable

      The downloaded version. Null means storage supplied no immutable version ID, including the legacy null version, so the URL follows the current object.

    • contentTypestringrequirednullable

      Media type of the stored body as recorded by storage, for example text/html or application/json, or null if none was recorded.

    • sizenumberrequirednullable

      Size of the stored body in bytes, or null if unknown.

    • lastModifiedstring (date-time)requirednullable

      When the current body was last written (ISO-8601 UTC), or null if unknown.

      matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • artifactobjectrequirednullable

    Null when the current body is absent. Retained versions may still exist.

    Show child attributes

    • contentUrlstringrequired

      Signed HTTPS URL that downloads the stored body without further authentication. It expires at the page's expiresAt (one hour); fetch the page again for a fresh link. Treat it as a secret.

    • currentVersionIdstringrequirednullable

      The downloaded version. Null means storage supplied no immutable version ID, including the legacy null version, so the URL follows the current object.

    • contentTypestringrequirednullable

      Media type of the stored body as recorded by storage, for example text/html or application/json, or null if none was recorded.

    • sizenumberrequirednullable

      Size of the stored body in bytes, or null if unknown.

    • lastModifiedstring (date-time)requirednullable

      When the current body was last written (ISO-8601 UTC), or null if unknown.

      matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

Errors

400

The request is malformed or failed validation.

401

The API key is missing, invalid or revoked.

403

The key is valid but may not perform this action on this resource.

404

The resource does not exist or is not visible to this key.

500

Something went wrong on Vetnio's side.

Get a retained version of a workspace note template

GET/workspaces/{workspaceId}/data-export/templates/version

AcceptsPersonal key

Path parameters

• workspaceIdstringrequired

  Identifier of the workspace (clinic) to export. The caller must be an admin of it, directly or as an admin of its organization.

Query parameters

• partenumoptional

  Which stored object of the template to read:

  • content — the template body itself.
  • instructions — the separate instructions object of an imported template (original wording and per-section instructions). Only workspace note and meeting templates have one; other kinds return 400.

  Default content

• templateIdstringrequired

  ID of the template, as returned in items[].id by the matching template export. It must belong to the workspace or organization in the path, otherwise 404.

  at least 1 characters · at most 512 characters

• versionIdstringrequired

  Opaque version ID from the versions list (versions[].versionId) or from artifact.currentVersionId. URL-encode it; it can contain characters such as +, / and =.

  at least 1 characters · at most 2048 characters

Returns

• currentVersionIdstringrequirednullable

  Version ID of the template's current body at the time of the request, or null when there is no current body. Unlike artifact.currentVersionId, a legacy unversioned body is reported here as the literal string "null".

• versionobjectrequired

  Metadata of the requested version.

  Show child attributes

  • versionIdstringrequired

    Opaque stored version ID. A literal null version belongs to unversioned or suspended storage and can be overwritten.

  • isLatestbooleanrequired

    true when this version is the template's current body.

  • lastModifiedstring (date-time)requirednullable

    When this version was stored (ISO-8601 UTC), or null if unknown.

    matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • sizenumberrequirednullable

    Size of this version's body in bytes, or null if unknown.

  • contentTypestringrequirednullable

    Media type of this version's body as recorded by storage, for example text/html or application/json, or null.

  • auditobjectrequirednullable

    Audit details of the edit that saved this version. Only available for workspace note templates and part=content; null otherwise, or when no matching audit entry exists. Not a clinical approval or accuracy classification.

    Show child attributes

    • idstringrequired

      ID of the audit-log entry (UUID).

    • occurredAtstring (date-time)required

      When the change was made (ISO-8601 UTC).

      matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

    • actorNamestringrequirednullable

      Display name of the person who made the change, or null when unknown or for system changes. For changes made by Vetnio support on a customer's behalf, this is the support staff member.

    • actorTypeenumrequired

      Who made the change:

      • user — a member of the customer's team.
      • vetnio_staff — Vetnio staff, for example while providing support.
      • system — an automated process.
    • actionstringrequired

      Audit action that saved this version, for example template.created, template.content_updated or template.restored.

    • s3VersionIdstringrequired

      The stored version ID the audit entry refers to; equals the version's versionId.

• contentstringrequired

  The exact retained body as UTF-8 text, including HTML instructions or the original JSON schema.

Errors

400

The request is malformed or failed validation.

401

The API key is missing, invalid or revoked.

403

The key is valid but may not perform this action on this resource.

404

The resource does not exist or is not visible to this key.

500

Something went wrong on Vetnio's side.

List retained versions of a workspace note template

GET/workspaces/{workspaceId}/data-export/templates/versions

AcceptsPersonal key

Path parameters

• workspaceIdstringrequired

  Identifier of the workspace (clinic) to export. The caller must be an admin of it, directly or as an admin of its organization.

Query parameters

• partenumoptional

  Which stored object of the template to read:

  • content — the template body itself.
  • instructions — the separate instructions object of an imported template (original wording and per-section instructions). Only workspace note and meeting templates have one; other kinds return 400.

  Default content

• templateIdstringrequired

  ID of the template, as returned in items[].id by the matching template export. It must belong to the workspace or organization in the path, otherwise 404.

  at least 1 characters · at most 512 characters

• cursorstringoptional

  Opaque pagination cursor: the nextCursor value from the previous page of this template's versions. Omit for the first page. URL-encode it.

  at least 1 characters · at most 2048 characters

Returns

• currentVersionIdstringrequirednullable

  Version ID of the template's current body at the time of the request, or null when there is no current body. Unlike artifact.currentVersionId, a legacy unversioned body is reported here as the literal string "null".

• versionsarray of objectsrequired

  Retained versions on this page, newest first. A page can hold fewer than 50 versions even when more follow.

  Show child attributes

  • versionIdstringrequired

    Opaque stored version ID. A literal null version belongs to unversioned or suspended storage and can be overwritten.

  • isLatestbooleanrequired

    true when this version is the template's current body.

  • lastModifiedstring (date-time)requirednullable

    When this version was stored (ISO-8601 UTC), or null if unknown.

    matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

  • sizenumberrequirednullable

    Size of this version's body in bytes, or null if unknown.

  • auditobjectrequirednullable

    Audit details of the edit that saved this version. Only available for workspace note templates and part=content; null otherwise, or when no matching audit entry exists. Not a clinical approval or accuracy classification.

    Show child attributes

    • idstringrequired

      ID of the audit-log entry (UUID).

    • occurredAtstring (date-time)required

      When the change was made (ISO-8601 UTC).

      matches `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$`

    • actorNamestringrequirednullable

      Display name of the person who made the change, or null when unknown or for system changes. For changes made by Vetnio support on a customer's behalf, this is the support staff member.

    • actorTypeenumrequired

      Who made the change:

      • user — a member of the customer's team.
      • vetnio_staff — Vetnio staff, for example while providing support.
      • system — an automated process.
    • actionstringrequired

      Audit action that saved this version, for example template.created, template.content_updated or template.restored.

    • s3VersionIdstringrequired

      The stored version ID the audit entry refers to; equals the version's versionId.

• nextCursorstringrequirednullable

  Pass this value as cursor to fetch older versions. null when the history is complete.

Errors

400

The request is malformed or failed validation.

401

The API key is missing, invalid or revoked.

403

The key is valid but may not perform this action on this resource.

404

The resource does not exist or is not visible to this key.

500

Something went wrong on Vetnio's side.