RESTCollectionModelBase_OpenApiClientNoteController.ClientNote

VeterinarySoftwareCloudPractice Management

Properties

Name Type Description
embed string
item array
page integer
recordsPerPage integer
searchQuery string
sort string
totalRecords integer
View JSON Schema on GitHub

JSON Schema

shepherd-vet-restcollection-model-base-open-api-client-note-controller-client-note-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/shepherd-vet/json-schema/shepherd-vet-restcollection-model-base-open-api-client-note-controller-client-note-schema.json",
  "title": "RESTCollectionModelBase_OpenApiClientNoteController.ClientNote",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/shepherd-vet-clientnote-api-openapi.yml#/components/schemas/RESTCollectionModelBase_OpenApiClientNoteController.ClientNote",
  "type": "object",
  "properties": {
    "embed": {
      "type": "string"
    },
    "item": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/OpenApiClientNoteController.ClientNote"
      }
    },
    "page": {
      "format": "int32",
      "type": "integer"
    },
    "recordsPerPage": {
      "format": "int32",
      "type": "integer"
    },
    "searchQuery": {
      "type": "string"
    },
    "sort": {
      "type": "string"
    },
    "totalRecords": {
      "format": "int32",
      "type": "integer"
    }
  },
  "$defs": {
    "OpenApiClientNoteController.ClientNote": {
      "description": "ClientNote REST model.",
      "type": "object",
      "properties": {
        "clientId": {
          "description": "Unique identifier representing the client associated with the note.",
          "type": "string"
        },
        "clinicId": {
          "description": "Unique identifier representing the clinic where the note was created.",
          "type": "string"
        },
        "createdByUser": {
          "$ref": "#/$defs/OpenApiClientNoteController.UserInfo",
          "description": "User who created the note."
        },
        "createdByUserId": {
          "description": "Unique identifier representing the user who created the note.",
          "type": "string"
        },
        "editedByPav2User": {
          "$ref": "#/$defs/OpenApiClientNoteController.Pav2User",
          "description": "The PAV2 user associated with the most recent edit of the note."
        },
        "editedByUser": {
          "$ref": "#/$defs/OpenApiClientNoteController.UserInfo",
          "description": "The user associated with the most recent edit of the note."
        },
        "editedByUserId": {
          "description": "Unique identifier representing the user who last edited the note.",
          "type": "string"
        },
        "isPinned": {
          "description": "Value indicating whether this ClientNote is pinned.",
          "type": "boolean"
        },
        "note": {
          "description": "HTML representation of the Note.",
          "type": "string"
        },
        "pav2User": {
          "$ref": "#/$defs/OpenApiClientNoteController.Pav2User",
          "description": "The PAV2 user who created the note."
        },
        "taggedUsersIds": {
          "description": "The list of the tagged users ids.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "dateCreated": {
          "format": "date-time",
          "type": "string"
        },
        "dateUpdated": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        }
      }
    },
    "OpenApiClientNoteController.Pav2User": {
      "description": "Pav2User rest model.",
      "type": "object",
      "properties": {
        "isDoctor": {
          "description": "Value indicating whether this user is a doctor.",
          "type": "boolean"
        },
        "prefix": {
          "description": "Prefix.",
          "type": "string"
        },
        "suffix": {
          "description": "Suffix.",
          "type": "string"
        },
        "dateCreated": {
          "format": "date-time",
          "type": "string"
        },
        "dateUpdated": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        }
      }
    },
    "OpenApiClientNoteController.UserInfo": {
      "description": "CoreUser REST model.",
      "type": "object",
      "properties": {
        "firstName": {
          "description": "User first name.",
          "type": "string"
        },
        "lastName": {
          "description": "User last name.",
          "type": "string"
        },
        "dateCreated": {
          "format": "date-time",
          "type": "string"
        },
        "dateUpdated": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/shepherd-vet-restcollection-model-base-open-api-client-note-controller-client-note"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.