{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/shepherd-vet/json-schema/shepherd-vet-open-api-client-patient-controller-client-patient-filter-model-schema.json",
  "title": "OpenApiClientPatientController.ClientPatientFilterModel",
  "description": "ClientPatient Filter REST model",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/shepherd-vet-clientpatient-api-openapi.yml#/components/schemas/OpenApiClientPatientController.ClientPatientFilterModel",
  "type": "object",
  "properties": {
    "clientIds": {
      "description": "Comma-separated list of Ids representing Client entities you wish to include in your search. 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"
    },
    "isDeleted": {
      "description": "Filters by client and patient deleted status. Defaults to null (fetches both deleted and non-deleted\nentities). In order to return a match, both patient and client entity should be in status Deleted = true.",
      "type": "boolean"
    },
    "patientIds": {
      "description": "Comma-separated list of Ids representing Patient entities you wish to include in your search. Defaults\nto null.",
      "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"
    }
  }
}