VEvetnio
link

List Link form templates

Lists journal form templates from the caller's Link tenant. By default every public (status=public) animal, herd, and combined animal-and-herd journal template is returned; Vetnio follows Link's pagination and returns all pages in one unpaginated array. Use it to let the vet pick the Link template a consultation's note should be written for. Returns 412 PRECONDITION_FAILED when the caller has no Link credentials in this workspace and 401 UNAUTHORIZED when Link rejects the stored API key.

get/workspaces/{workspaceId}/link/templates

Request

  • Base URL
    https://vetnio.com/api/v2
  • URL
    https://vetnio.com/api/v2/workspaces/{workspaceId}/link/templates
  • 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

Query parameters

kindstring

Link template kind filter, passed to Link unchanged. Accepts a single kind or a comma-separated list (animal_journal, animal_certificate, herd_journal, animal_and_herd_journal, quotation). Defaults to animal_journal,herd_journal,animal_and_herd_journal.

Example:animal_journal
statusstring

Link template status filter, passed to Link unchanged: public (published) or edit (draft). Defaults to public.

Example:public

Response

Array of Link template summaries.

idinteger required

Link form template id. Pass it to the template detail and resolve endpoints.

namestring required

Template name as shown in Link.

descriptionstring nullable required

Template description from Link, or null when it has none.

kindstring required

Link template kind, passed through from Link. Values documented by Link: animal_journal, animal_certificate, herd_journal, animal_and_herd_journal, quotation.

statusstring required

Link template status, passed through from Link. Values documented by Link: public (published, usable for new entries) and edit (draft).

Example response

[
  {
    "id": 3423,
    "name": "Allmän undersökning hund",
    "kind": "animal_journal",
    "status": "public"
  }
]

Changes

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