---
title: "List compatible Link entries"
method: GET
path: "/workspaces/{workspaceId}/consultations/{consultationId}/link/compatible-entries"
tags: ["link"]
---

# List compatible Link entries

`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

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.

## Path parameters

- `workspaceId` string, 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.
- `consultationId` string, required: Identifier of the Vetnio consultation (UUID) whose structured clinical note is exported to, or matched against, Link.

## Query parameters

- `customerId` integer, required: Link customer (animal owner) id, as returned in `customers[].id` by the customer search endpoint.
- `animalId` integer, required: Link animal id, as returned in `id` by the animal list endpoints. The animal must be owned by `customerId`.

## Response `200`

Compatible Link entry candidates.

- object[]
  - `id` integer, required: Link journal entry id. Pass it as `targetEntryId` to the export endpoint to write into this entry.
  - `title` string, required: Entry title as shown in Link.
  - `createdAt` string, required: When the entry was created in Link, passed through as Link returns it (ISO-8601, may carry a local UTC offset).
  - `visitReason` string, 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.

## Other responses

- `400`: Invalid input data
- `401`: Authorization not provided
- `403`: Insufficient access
- `404`: Not found
- `500`: Internal server error

---

[API](https://skmtc.dev/vetnio/apis/vetnio-api.md) - [All operations](https://skmtc.dev/vetnio/apis/vetnio-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vetnio/apis/vetnio-api/revisions/d004afd5617d?raw)