{
  "$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"
    }
  }
}