OpenApiAppointmentController.AppointmentFilterModel

Appointment Filter model.

VeterinarySoftwareCloudPractice Management

Properties

Name Type Description
appointmentStatusIds string Comma-separated string of AppointmentStatus identifiers. Defaults to null (fetches appointments by all statuses, if appointment status ID is provided, only appointments with those statuses are shown.
cancellationReasonIds string Comma-separated string of Cancellation reason identifiers. Defaults to null (fetches appointments that aren't cancelled, if cancellation reason ID is provided, only appointments which are cancelled ar
clientIds string Comma-separated string of Client identifiers. Defaults to null (fetches appointments for all clients, if client IDs are provided, only appointments for those clients are shown).
clinicIds string Comma-separated list of Clinic identifiers. Defaults to null. The filter is applicable only if the group to which the clinic belongs shares clients and patients.
dateFrom string Filters appointments whose time overlaps with DateFrom - DateTo range.
dateTo string Filters appointments whose time overlaps with DateFrom - DateTo range.
includePatientHomeClinic boolean Used to support multi-site practices that share patients and clients. Determines whether to include Appointment patients from a patient's home clinic when filtering by clinic. Behavior: - If true: - I
isBlockedOff boolean Filters by whether appointment is blocked off. Defaults to null (fetches both blocked off and non-blocked off appointments).
isDeleted boolean Filters by deleted status. Defaults to null (fetches both deleted and non-deleted entities).
patientIds string Comma-separated string of Patient identifiers. Defaults to null (fetches appointments for all patients, if patient IDs are provided, only appointments for those patients are shown).
providerIds string Comma-separated string of Provider identifiers. Defaults to null. If provided, fetches all appointments for specified provider(s).
searchQuery string Filters by visit reason, patient names and client name.
dateCreatedFrom string Sets the start of the date range filter on the entity creation date. Must not be later than DateCreatedTo, or the request returns 400. Defaults to null.
dateCreatedTo string The end of the date range filter on the entity creation date. Defaults to null.
dateUpdatedFrom string The start of the date range filter on the entity last update date. Must not be later than DateUpdatedTo, or the request returns 400. Defaults to null.
dateUpdatedTo string The end of the date range filter on the entity last update date. Defaults to null.
embed string Comma-separated list of embedded properties to fetch. Nested fetches can be specified using dot notation (e.g., "client.clientPhones"). Defaults to null.
excludeIds string Comma-separated list of IDs representing entities that you wish to exclude from your search. Defaults to null.
ids string Comma-separated list of IDs representing entities that you wish to include in your search. Defaults to null.
page integer The page number. Defaults to 1.
rpp integer The number of items to return per page. The max is 1000. Defaults to 10.
sort string Which field to sort by. Needs to be in "field|order" format, where order is either "asc" or "desc". The default sort field depends on the endpoint, typically "id|asc"
View JSON Schema on GitHub

JSON Schema

shepherd-vet-open-api-appointment-controller-appointment-filter-model-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/shepherd-vet/json-schema/shepherd-vet-open-api-appointment-controller-appointment-filter-model-schema.json",
  "title": "OpenApiAppointmentController.AppointmentFilterModel",
  "description": "Appointment Filter model.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/shepherd-vet-appointment-api-openapi.yml#/components/schemas/OpenApiAppointmentController.AppointmentFilterModel",
  "type": "object",
  "properties": {
    "appointmentStatusIds": {
      "description": "Comma-separated string of AppointmentStatus identifiers. Defaults to null (fetches appointments by all statuses, if appointment status ID is provided, only appointments with those statuses are shown.",
      "type": "string"
    },
    "cancellationReasonIds": {
      "description": "Comma-separated string of Cancellation reason identifiers. Defaults to null (fetches appointments that aren't cancelled, if cancellation reason ID is provided, only appointments which are cancelled are shown.",
      "type": "string"
    },
    "clientIds": {
      "description": "Comma-separated string of Client identifiers. Defaults to null (fetches appointments for all clients, if client IDs are provided, only appointments for those clients are shown).",
      "type": "string"
    },
    "clinicIds": {
      "description": "Comma-separated list of Clinic identifiers. Defaults to null. The filter is applicable only if the group to which the clinic belongs shares clients and patients.",
      "type": "string"
    },
    "dateFrom": {
      "format": "date-time",
      "description": "Filters appointments whose time overlaps with DateFrom - DateTo range.",
      "type": "string"
    },
    "dateTo": {
      "format": "date-time",
      "description": "Filters appointments whose time overlaps with DateFrom - DateTo range.",
      "type": "string"
    },
    "includePatientHomeClinic": {
      "description": "Used to support multi-site practices that share patients and clients.\nDetermines whether to include Appointment patients from a patient's home clinic\nwhen filtering by clinic.\n            \nBehavior:\n- If true:\n  - Includes Appointment patients from the specified clinic (default)\n  - Also includes appointment patients from other clinics where the patient's home clinic\n    matches the specified clinic\n- If false (default):\n  - Only includes Appointment patients directly from the specified clinic\n            \nNote: The patient's home clinic is only considered if ClinicIds are provided\nin the filter; otherwise, all data from the group is returned.",
      "type": "boolean"
    },
    "isBlockedOff": {
      "description": "Filters by whether appointment is blocked off. Defaults to null (fetches both blocked off and non-blocked off appointments).",
      "type": "boolean"
    },
    "isDeleted": {
      "description": "Filters by deleted status. Defaults to null (fetches both deleted and non-deleted entities).",
      "type": "boolean"
    },
    "patientIds": {
      "description": "Comma-separated string of Patient identifiers. Defaults to null (fetches appointments for all patients, if patient IDs are provided, only appointments for those patients are shown).",
      "type": "string"
    },
    "providerIds": {
      "description": "Comma-separated string of Provider identifiers. Defaults to null. If provided, fetches all appointments for specified provider(s).",
      "type": "string"
    },
    "searchQuery": {
      "description": "Filters by visit reason, patient names and client name.",
      "type": "string"
    },
    "dateCreatedFrom": {
      "format": "date-time",
      "description": "Sets the start of the date range filter on the entity creation date. Must not be later than DateCreatedTo, or\nthe request returns 400. Defaults to null.",
      "type": "string"
    },
    "dateCreatedTo": {
      "format": "date-time",
      "description": "The end of the date range filter on the entity creation date. Defaults to null.",
      "type": "string"
    },
    "dateUpdatedFrom": {
      "format": "date-time",
      "description": "The start of the date range filter on the entity last update date. Must not be later than DateUpdatedTo, or the\nrequest returns 400. Defaults to null.",
      "type": "string"
    },
    "dateUpdatedTo": {
      "format": "date-time",
      "description": "The end of the date range filter on the entity last update date. Defaults to null.",
      "type": "string"
    },
    "embed": {
      "description": "Comma-separated list of embedded properties to fetch. Nested fetches can be specified using dot notation (e.g., \"client.clientPhones\"). Defaults to null.",
      "type": "string"
    },
    "excludeIds": {
      "description": "Comma-separated list of IDs representing entities that you wish to exclude from your search. Defaults to null.",
      "type": "string"
    },
    "ids": {
      "description": "Comma-separated list of IDs representing entities that you wish to include in your search. Defaults to null.",
      "type": "string"
    },
    "page": {
      "format": "int32",
      "description": "The page number. Defaults to 1.",
      "type": "integer"
    },
    "rpp": {
      "format": "int32",
      "description": "The number of items to return per page. The max is 1000. Defaults to 10.",
      "type": "integer"
    },
    "sort": {
      "description": "Which field to sort by. Needs to be in \"field|order\" format, where order is either \"asc\" or \"desc\". The default sort field depends on the endpoint, typically \"id|asc\"",
      "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-open-api-appointment-controller-appointment-filter-model"
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.