json-templates

Get JSON template detail

Returns a JSON template with its full JSON Schema. jsonTemplateSchema.properties lists the fields a generated document will contain, keyed exactly as in the output, so you can map them to your own system or render a structured clinical note.

Available to any workspace member for the workspace's own and the built-in JSON templates. An ID from another workspace, or one that does not exist, returns 404. Requires a personal API key.

get/workspaces/{workspaceId}/json-templates/{jsonTemplateId}

Request

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

jsonTemplateIdstring required

ID of the JSON template (a UUID), from List JSON templates. Either one of this workspace's JSON templates or a built-in one; anything else returns 404.

Example:2a859133-0e04-4f63-88d2-aa0ee318cd8d

Response

The template and its schema.

idstring required

ID of the JSON template (a UUID).

namestring nullable required

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

createdAtstring required

When the template was created, as an ISO-8601 UTC timestamp. Built-in templates report 1970-01-01T00:00:00.000Z.

Example response

{
  "id": "2a859133-0e04-4f63-88d2-aa0ee318cd8d",
  "name": "Soap Note for Dog",
  "jsonTemplateSchema": {
    "type": "object",
    "title": "Lameness examination",
    "description": "Structured lameness work-up for horses.",
    "properties": {
      "anamnesis": {
        "type": "string",
        "title": "Anamnesis",
        "description": "History and presenting complaint as discussed. Leave empty if not mentioned."
      },
      "weight_kg": {
        "type": "number",
        "description": "Body weight in kilograms, if stated."
      },
      "contact_preference": {
        "type": "string",
        "enum": [
          "Phone",
          "Email"
        ],
        "description": "How the owner wants to be contacted."
      }
    },
    "required": [
      "anamnesis"
    ]
  },
  "createdAt": "2026-08-21T13:05:00.000Z"
}

Changes

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