json-templates

List JSON templates

Returns the ID and name of every JSON template (called structured templates in Vetnio) available in the workspace: the workspace's own, followed by Vetnio's built-in ones. Use the ID with Generate a structured document, or fetch the fields with Get JSON template detail.

Every workspace member sees every JSON template; there are no per-user visibility rules. The list is not paginated and the order of the workspace's own templates is not guaranteed. Requires a personal API key.

get/workspaces/{workspaceId}/json-templates

Request

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

Response

The workspace's JSON templates followed by the built-in ones. Never empty, because the built-in templates are always included.

idstring required

ID of the JSON template (a UUID). Pass it as jsonTemplateId to Get JSON template detail, Generate a structured document or Create a template. Built-in templates have the same ID in every workspace.

namestring nullable required

Name of the structured template as shown in Vetnio. null if it was saved without a name.

descriptionstring

Short description of the template's purpose. Only built-in templates have one; the field is absent for templates created in the workspace.

Example response

[
  {
    "id": "2a859133-0e04-4f63-88d2-aa0ee318cd8d",
    "name": "Soap Note for Dog",
    "description": "A template for a soap note for a dog."
  }
]

Changes

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