OpenApiClientController.ClientFilterModel

Client Filter REST model

VeterinarySoftwareCloudPractice Management

Properties

Name Type Description
clientStatusIds string Comma-separated list of ClientStatus identifiers. Defaults to null.
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.
hasEmailDirectMessagingNotification boolean Filters by email direct messaging notification status. Defaults to null (fetches both enabled and disabled).
hasEmailMassCommunicationNotification boolean Filters by email mass communication notification status. Defaults to null (fetches both enabled and disabled).
hasEmailNotification boolean Filters by email notification status. Defaults to null (fetches both enabled and disabled).
hasReminderEmailNotification boolean Filters by reminder email notification status. Defaults to null (fetches both enabled and disabled).
hasReminderPostcardNotification boolean Filters by reminder postcard notification status. Defaults to null (fetches both enabled and disabled).
hasReminderSmsNotification boolean Filters by reminder SMS notification status. Defaults to null (fetches both enabled and disabled).
hasSmsDirectMessagingNotification boolean Filters by sms direct messaging notification status. Defaults to null (fetches both enabled and disabled).
hasSmsMassCommunicationNotification boolean Filters by sms mass communication notification status. Defaults to null (fetches both enabled and disabled).
hasSmsNotification boolean Filters by sms notification status. Defaults to null (fetches both enabled and disabled).
identifiers string Client-facing identifier that are displayed in the application
isDeleted boolean Filters by deleted status. Defaults to null (fetches both deleted and non-deleted entities).
isSubscribedToNotifications boolean Filters by subscribed to notifications status. Defaults to null (fetches both subscribed and not subscribed to notifications).
isSubscribedToSmsNotifications boolean Filters by subscribed to SMS notifications status. Defaults to null (fetches both subscribed and not subscribed to SMS notifications).
patientIds string Comma-separated list of Ids representing Patient entities whose owners are the clients you wish to include in your search. Defaults to null.
phoneNumbers string Comma-separated list of PhoneNumbers. Defaults to null.
searchQuery string Filters by the client first name, last name and email.
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-client-controller-client-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-client-controller-client-filter-model-schema.json",
  "title": "OpenApiClientController.ClientFilterModel",
  "description": "Client Filter REST model",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/shepherd-vet-client-api-openapi.yml#/components/schemas/OpenApiClientController.ClientFilterModel",
  "type": "object",
  "properties": {
    "clientStatusIds": {
      "description": "Comma-separated list of ClientStatus identifiers. Defaults to null.",
      "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"
    },
    "hasEmailDirectMessagingNotification": {
      "description": "Filters by email direct messaging notification status. Defaults to null (fetches both enabled and disabled).",
      "type": "boolean"
    },
    "hasEmailMassCommunicationNotification": {
      "description": "Filters by email mass communication notification status. Defaults to null (fetches both enabled and disabled).",
      "type": "boolean"
    },
    "hasEmailNotification": {
      "description": "Filters by email notification status. Defaults to null (fetches both enabled and disabled).",
      "type": "boolean"
    },
    "hasReminderEmailNotification": {
      "description": "Filters by reminder email notification status. Defaults to null (fetches both enabled and disabled).",
      "type": "boolean"
    },
    "hasReminderPostcardNotification": {
      "description": "Filters by reminder postcard notification status. Defaults to null (fetches both enabled and disabled).",
      "type": "boolean"
    },
    "hasReminderSmsNotification": {
      "description": "Filters by reminder SMS notification status. Defaults to null (fetches both enabled and disabled).",
      "type": "boolean"
    },
    "hasSmsDirectMessagingNotification": {
      "description": "Filters by sms direct messaging notification status. Defaults to null (fetches both enabled and disabled).",
      "type": "boolean"
    },
    "hasSmsMassCommunicationNotification": {
      "description": "Filters by sms mass communication notification status. Defaults to null (fetches both enabled and disabled).",
      "type": "boolean"
    },
    "hasSmsNotification": {
      "description": "Filters by sms notification status. Defaults to null (fetches both enabled and disabled).",
      "type": "boolean"
    },
    "identifiers": {
      "description": "Client-facing identifier that are displayed in the application",
      "type": "string"
    },
    "isDeleted": {
      "description": "Filters by deleted status. Defaults to null (fetches both deleted and non-deleted entities).",
      "type": "boolean"
    },
    "isSubscribedToNotifications": {
      "description": "Filters by subscribed to notifications status. Defaults to null (fetches both subscribed and not subscribed to notifications).",
      "type": "boolean"
    },
    "isSubscribedToSmsNotifications": {
      "description": "Filters by subscribed to SMS notifications status. Defaults to null (fetches both subscribed and not subscribed to SMS notifications).",
      "type": "boolean"
    },
    "patientIds": {
      "description": "Comma-separated list of Ids representing Patient entities whose owners are the clients you wish to\ninclude in your search. Defaults to null.",
      "type": "string"
    },
    "phoneNumbers": {
      "description": "Comma-separated list of PhoneNumbers. Defaults to null.",
      "type": "string"
    },
    "searchQuery": {
      "description": "Filters by the client first name, last name and email.",
      "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-client-controller-client-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.