---
title: "List JSON templates"
method: GET
path: "/workspaces/{workspaceId}/json-templates"
tags: ["json-templates"]
---

# List JSON templates

`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

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.

## 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.

## Response `200`

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

- JsonTemplateMetadataItem[]: The workspace's own JSON templates (in no guaranteed order) followed by Vetnio's built-in JSON templates, which are available in every workspace.
  - `id` string, 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.
  - `name` string, nullable, required: Name of the structured template as shown in Vetnio. `null` if it was saved without a name.
  - `description` string: Short description of the template's purpose. Only built-in templates have one; the field is absent for templates created in the workspace.

## 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)