consultations

List consultations with export URLs

Paginated list of all consultations in the workspace, regardless of creator, including archived consultations and consultations deleted in the Vetnio app (rows do not say which). Each row includes the selected clinical note template ID (clinicalNoteTemplateId, or null if none is selected) and presigned download URLs for the audio recording, transcription, clinical note, structured JSON document, owner communication, and referral letter (or null when the artifact does not exist). Workspace admin only.

Creator-only playback settings do not apply to this authorized admin export.

Optional createdAtFrom (inclusive) and createdAtBefore (exclusive) filter the consultation creation timestamp, not the last edit or recording time. Supply ISO-8601 timestamps with Z or an explicit offset. Filters apply before pagination and to the total count. Results are ordered by createdAt descending, then ID descending. Omit either bound for an open-ended range.

Pair with GET .../data-export for single-consultation export, or use this endpoint to build a bulk export UI. URLs expire after 1 hour; re-fetch the page if they go stale. Each row checks storage for six artifacts, so larger pages take noticeably longer.

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

Request

Base URL
https://vetnio.com/api/v2
URL
https://vetnio.com/api/v2/workspaces/{workspaceId}/data-export/consultations
Auth
HTTP bearer

Path parameters

workspaceIdstring required

Workspace to list consultations for.

Example:furunculotic-loud-chihuahua

Query parameters

pageinteger

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

Example:1

pageSizeinteger

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

Example:10

searchQuerystring

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.

Example:Bella

createdAtFromstring date-time

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.

Example:2026-09-01T00:00:00Z

createdAtBeforestring date-time

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.

Example:2026-10-01T00:00:00Z

Response

Paginated consultation list with presigned export URLs.

countnumber required

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

pagenumber required

Current page number (1-indexed).

pageSizenumber required

Consultations per page.

totalPagesnumber required

Total pages given the current page size.

expiresInSecondsnumber required

How long each presigned URL remains valid, in seconds.

expiresAtstring required

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

Example response

{
  "consultations": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Bella - annual checkup",
      "creatorId": "b8c9d0e1-f2a3-4456-bcde-678901234567",
      "createdAt": "2026-09-14T08:30:00.000Z",
      "externalId": "123456",
      "clinicalNoteTemplateId": "6a4dd7d0-0fe8-4f73-8e05-8898748da1ce"
    }
  ],
  "count": 142,
  "page": 1,
  "pageSize": 10,
  "totalPages": 15,
  "expiresInSeconds": 3600,
  "expiresAt": "2026-04-16T14:00:00.000Z"
}

Changes

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