link

List compatible Link entries

Returns up to three existing journal entries in the selected animal's Link journal that this consultation's structured note could be written into instead of creating a new entry: newest first, not locked, deleted or cancelled, and created from the consultation's Link template or one with an identical ordered list of writable fields. Pass a candidate's id as targetEntryId to the export endpoint. The consultation must use a Link JSON template (see the resolve endpoint), otherwise 400 BAD_REQUEST; 404 NOT_FOUND when the animal does not belong to the customer or the Link template can no longer be found in the tenant.

get/workspaces/{workspaceId}/consultations/{consultationId}/link/compatible-entries

Request

  • Base URL
    https://vetnio.com/api/v2
  • URL
    https://vetnio.com/api/v2/workspaces/{workspaceId}/consultations/{consultationId}/link/compatible-entries
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required

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.

Example:furunculotic-loud-chihuahua
consultationIdstring required

Identifier of the Vetnio consultation (UUID) whose structured clinical note is exported to, or matched against, Link.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Query parameters

customerIdinteger required

Link customer (animal owner) id, as returned in customers[].id by the customer search endpoint.

Example:54967922
animalIdinteger required

Link animal id, as returned in id by the animal list endpoints. The animal must be owned by customerId.

Example:1234567

Response

Compatible Link entry candidates.

idinteger required

Link journal entry id. Pass it as targetEntryId to the export endpoint to write into this entry.

titlestring required

Entry title as shown in Link.

createdAtstring required

When the entry was created in Link, passed through as Link returns it (ISO-8601, may carry a local UTC offset).

visitReasonstring nullable required

Visit reason(s) of the Link appointment the entry belongs to, comma-separated, falling back to the appointment description. null when the entry has no appointment or it could not be loaded.

Example response

[
  {
    "id": 8812345,
    "title": "Allmän undersökning hund",
    "createdAt": "2026-10-01T09:30:00.000+02:00",
    "visitReason": "Vaccination"
  }
]

Changes

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