Clinical data export

Export raw consultation data

GET/workspaces/{workspaceId}/consultations/{consultationId}/data-export

AcceptsPersonal key

Path parameters

• workspaceIdstringrequired

  Identifier of the clinic (workspace), as returned by GET /workspaces. The key's user must be a member of the clinic, or an admin of the organization it belongs to.

• consultationIdstringrequired

  Identifier of the consultation (UUID), as returned when it was created or by GET /workspaces/{workspaceId}/consultations. It must belong to the clinic in workspaceId.

Returns

• structuredDocumentstringrequirednullable

  Presigned GET URL for the separately stored structured JSON document, or null if none exists. The payload matches the JSON template used to generate it; it is not the rendered clinical note.

• communicationstringrequirednullable

  Presigned GET URL for the owner communication in its stored format, or null if none exists.

• referralstringrequirednullable

  Presigned GET URL for the referral letter in its stored format, or null if none exists.

• consultationIdstringrequired

  The consultation these artifacts belong to.

• workspaceIdstringrequired

  The workspace that owns the consultation.

• externalIdstringrequirednullable

  External ID from an integrated system, or null if the consultation is not linked to one.

• expiresInSecondsnumberrequired

  How long each presigned download URL remains valid, in seconds.

• expiresAtstringrequired

  ISO-8601 timestamp at which the download URLs expire. Provided for convenience so clients can display a countdown without computing it themselves.

• audioRecordingstringrequirednullable

  Presigned GET URL for the full consultation audio: every uploaded recording joined into one 16 kHz mono WAV file, silence included. null if no audio exists (for example a text-only consultation, or audio removed by the clinic's audio-retention policy). Creator-only playback settings do not apply to authorized admin exports.

• transcriptionstringrequirednullable

  Presigned GET URL for the full transcript as a UTF-8 plain-text file (the same text as GET .../transcription), or null if nothing has been transcribed yet.

• clinicalNotestringrequirednullable

  Presigned GET URL for the stored clinical note (HTML, or JSON for structured notes), or null if no note has been saved yet.

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 consultations with export URLs

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

AcceptsPersonal key

Path parameters

• workspaceIdstringrequired

  Workspace to list consultations for.

Query parameters

• pageintegeroptional

  Page to return, starting at 1. Defaults to 1. Pages past the end return an empty consultations array.

  Default 1 · ≥ 1 · ≤ 9007199254740991

• pageSizeintegeroptional

  Consultations per page, 1 to 50. Defaults to 10. Capped at 50 because each row includes presigned download URLs for six artifacts.

  Default 10 · ≥ 1 · ≤ 50

• searchQuerystringoptional

  Case-insensitive substring filter matched against the consultation name, the plain text of its clinical note, its externalId, and the linked patient's name or identifier. Surrounding whitespace is ignored; omit for no filter.

• createdAtFromstring (date-time)optional

  Inclusive lower bound on the consultation creation timestamp (not last edit or recording time). ISO-8601 with Z or an explicit timezone offset. Omit for no lower bound.

  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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$`

• createdAtBeforestring (date-time)optional

  Exclusive upper bound on the consultation creation timestamp. ISO-8601 with Z or an explicit timezone offset. Must be later than createdAtFrom. Omit for no upper bound.

  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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$`

Returns

• consultationsarray of objectsrequired

  Consultations on the current page, each with presigned download URLs for its artifacts.

  Show child attributes

  • structuredDocumentstringrequirednullable

    Presigned GET URL for the separately stored structured JSON document, or null if none exists. The payload matches the JSON template used to generate it; it is not the rendered clinical note.

  • communicationstringrequirednullable

    Presigned GET URL for the owner communication in its stored format, or null if none exists.

  • referralstringrequirednullable

    Presigned GET URL for the referral letter in its stored format, or null if none exists.

  • idstringrequired

    Consultation ID (UUID).

  • namestringrequired

    Display name of the consultation; may be an empty string.

  • creatorIdstringrequired

    User ID of the person who created the consultation.

  • createdAtstringrequired

    When the consultation was created, as an ISO-8601 UTC timestamp. The createdAtFrom/createdAtBefore filters and the sort order use this value.

  • externalIdstringrequirednullable

    Identifier of the matching visit in the clinic's practice-management system, or null if the consultation is not linked to one.

  • clinicalNoteTemplateIdstringrequirednullable

    ID of the clinical note template selected for the consultation, or null if none is selected.

  • audioRecordingstringrequirednullable

    Presigned GET URL for the full consultation audio (all uploaded recordings joined into one 16 kHz mono WAV file), or null if no audio exists or it was removed by the clinic's audio-retention policy. Creator-only playback settings do not apply to authorized admin exports.

  • transcriptionstringrequirednullable

    Presigned GET URL for the full transcript as a UTF-8 plain-text file, or null if nothing has been transcribed yet.

  • clinicalNotestringrequirednullable

    Presigned GET URL for the stored clinical note (HTML, or JSON for structured notes), or null if no note has been saved yet.

• countnumberrequired

  Total consultations matching the filters across all pages, including archived and deleted ones.

• pagenumberrequired

  Current page number (1-indexed).

• pageSizenumberrequired

  Consultations per page.

• totalPagesnumberrequired

  Total pages given the current page size.

• expiresInSecondsnumberrequired

  How long each presigned URL remains valid, in seconds.

• expiresAtstringrequired

  ISO-8601 timestamp at which the presigned URLs in this response expire.

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.