Shepherd Veterinary Software · Schema
OpenApiClientController.Client
Client REST model.
VeterinarySoftwareCloudPractice Management
Properties
| Name | Type | Description |
|---|---|---|
| additionalText | string | Free-text field of additional info for the client. |
| alerts | string | Important info for the client, e.g. "Difficult to work with" |
| authorizedAgents | array | The list of related AuthorizedAgent objects. |
| clientCoOwner | object | Object representing related ClientCoOwner entity. |
| clientDiscountId | string | Unique identifier representing the related ClientDiscount entity. |
| clientGender | object | Object representing related ClientGender entity. |
| clientInfo | object | Object representing related ClientInfo entity. |
| clientPhones | array | The list of related ClientPhone objects. |
| clientStatus | object | Object representing related ClientStatus entity. |
| clientStatusId | string | Unique identifier representing the related ClientStatus entity. |
| clientType | object | Object representing related ClientType entity. |
| clientTypeId | string | Unique identifier representing the related ClientType entity. |
| clinicId | string | Unique identifier representing the related Clinic entity. |
| dateDeleted | string | Date indicating when this client was deleted. |
| dateOfBirth | string | Birth date of the client. |
| deleted | boolean | Value indicating whether this client is deleted. Defaults to false. |
| string | Email address of the client. | |
| emailDirectMessagingNotification | boolean | Flag indicating whether the client accepts direct messaging Email notifications. |
| emailMassCommunicationNotification | boolean | Flag indicating whether the client accepts Email mass communication notifications. |
| emailNotification | boolean | Flag indicating whether the client accepts Email notifications. |
| firstName | string | The client's first name. |
| genderId | string | Unique identifier representing the related Gender entity. |
| identifier | string | The client's short unique identifier inside the clinic. Clients from different clinics can have the same value. |
| isSubscribedToNotifications | boolean | Flag indicating whether the client is subscribed to notifications. If false, no email or SMS notifications should be sent to the client. |
| isSubscribedToSmsNotifications | boolean | Flag indicating whether the client is subscribed to sms notifications. If false, no SMS notifications should be sent to the client. |
| isTaxExempt | boolean | Flag indicating whether the client is exempt from taxes. |
| lastName | string | The client's last name. |
| legacyId | string | The client's legacy identifier from a previous PIMS. |
| middleName | string | The client's middle name. |
| referralSourceIds | array | Unique identifier list representing the related ReferralSource entities. |
| reminderEmailNotification | boolean | Flag indicating whether the client accepts reminder Email notifications. |
| reminderPostcardNotification | boolean | Flag indicating whether the client accepts reminder Postcard notifications. |
| reminderSmsNotification | boolean | Flag indicating whether the client accepts reminder SMS notifications. |
| smsDirectMessagingNotification | boolean | Flag indicating whether the client accepts SMS direct messaging notifications. |
| smsMassCommunicationNotification | boolean | Flag indicating whether the client accepts SMS mass communication notifications. |
| smsNotification | boolean | Flag indicating whether the client accepts SMS notifications. |
| dateCreated | string | |
| dateUpdated | string | |
| id | string |
JSON Schema
{
"$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-schema.json",
"title": "OpenApiClientController.Client",
"description": "Client 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.Client",
"type": "object",
"properties": {
"additionalText": {
"description": "Free-text field of additional info for the client.",
"type": "string"
},
"alerts": {
"description": "Important info for the client, e.g. \"Difficult to work with\"",
"type": "string"
},
"authorizedAgents": {
"description": "The list of related AuthorizedAgent objects.",
"type": "array",
"items": {
"$ref": "#/$defs/OpenApiClientController.AuthorizedAgent"
}
},
"clientCoOwner": {
"$ref": "#/$defs/OpenApiClientController.ClientCoOwner",
"description": "Object representing related ClientCoOwner entity."
},
"clientDiscountId": {
"description": "Unique identifier representing the related ClientDiscount entity.",
"type": "string"
},
"clientGender": {
"$ref": "#/$defs/OpenApiClientController.ClientGender",
"description": "Object representing related ClientGender entity."
},
"clientInfo": {
"$ref": "#/$defs/OpenApiClientController.ClientInfo",
"description": "Object representing related ClientInfo entity."
},
"clientPhones": {
"description": "The list of related ClientPhone objects.",
"type": "array",
"items": {
"$ref": "#/$defs/OpenApiClientController.ClientPhone"
}
},
"clientStatus": {
"$ref": "#/$defs/OpenApiClientController.ClientStatus",
"description": "Object representing related ClientStatus entity."
},
"clientStatusId": {
"description": "Unique identifier representing the related ClientStatus entity.",
"type": "string"
},
"clientType": {
"$ref": "#/$defs/OpenApiClientController.ClientType",
"description": "Object representing related ClientType entity."
},
"clientTypeId": {
"description": "Unique identifier representing the related ClientType entity.",
"type": "string"
},
"clinicId": {
"description": "Unique identifier representing the related Clinic entity.",
"type": "string"
},
"dateDeleted": {
"format": "date-time",
"description": "Date indicating when this client was deleted.",
"type": "string"
},
"dateOfBirth": {
"format": "date-time",
"description": "Birth date of the client.",
"type": "string"
},
"deleted": {
"description": "Value indicating whether this client is deleted. Defaults to false.",
"type": "boolean"
},
"email": {
"description": "Email address of the client.",
"type": "string"
},
"emailDirectMessagingNotification": {
"description": "Flag indicating whether the client accepts direct messaging Email notifications.",
"type": "boolean"
},
"emailMassCommunicationNotification": {
"description": "Flag indicating whether the client accepts Email mass communication notifications.",
"type": "boolean"
},
"emailNotification": {
"description": "Flag indicating whether the client accepts Email notifications.",
"type": "boolean"
},
"firstName": {
"description": "The client's first name.",
"type": "string"
},
"genderId": {
"description": "Unique identifier representing the related Gender entity.",
"type": "string"
},
"identifier": {
"description": "The client's short unique identifier inside the clinic. Clients from different clinics can have the same value.",
"type": "string"
},
"isSubscribedToNotifications": {
"description": "Flag indicating whether the client is subscribed to notifications. If false, no email or SMS\nnotifications should be sent to the client.",
"type": "boolean"
},
"isSubscribedToSmsNotifications": {
"description": "Flag indicating whether the client is subscribed to sms notifications. If false, no SMS\nnotifications should be sent to the client.",
"type": "boolean"
},
"isTaxExempt": {
"description": "Flag indicating whether the client is exempt from taxes.",
"type": "boolean"
},
"lastName": {
"description": "The client's last name.",
"type": "string"
},
"legacyId": {
"description": "The client's legacy identifier from a previous PIMS.",
"type": "string"
},
"middleName": {
"description": "The client's middle name.",
"type": "string"
},
"referralSourceIds": {
"description": "Unique identifier list representing the related ReferralSource entities.",
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"reminderEmailNotification": {
"description": "Flag indicating whether the client accepts reminder Email notifications.",
"type": "boolean"
},
"reminderPostcardNotification": {
"description": "Flag indicating whether the client accepts reminder Postcard notifications.",
"type": "boolean"
},
"reminderSmsNotification": {
"description": "Flag indicating whether the client accepts reminder SMS notifications.",
"type": "boolean"
},
"smsDirectMessagingNotification": {
"description": "Flag indicating whether the client accepts SMS direct messaging notifications.",
"type": "boolean"
},
"smsMassCommunicationNotification": {
"description": "Flag indicating whether the client accepts SMS mass communication notifications.",
"type": "boolean"
},
"smsNotification": {
"description": "Flag indicating whether the client accepts SMS notifications.",
"type": "boolean"
},
"dateCreated": {
"format": "date-time",
"type": "string"
},
"dateUpdated": {
"format": "date-time",
"type": "string"
},
"id": {
"type": "string"
}
},
"$defs": {
"OpenApiClientController.AuthorizedAgent": {
"description": "AuthorizedAgent REST model.",
"type": "object",
"properties": {
"approvalNote": {
"description": "The authorized agent's note.",
"type": "string"
},
"firstName": {
"description": "The authorized agent's first name.",
"type": "string"
},
"lastName": {
"description": "The authorized agent's last name.",
"type": "string"
},
"phoneNumber": {
"description": "The authorized agent's phone number.",
"type": "string"
},
"role": {
"description": "The authorized agent's role.",
"type": "string"
},
"dateCreated": {
"format": "date-time",
"type": "string"
},
"dateUpdated": {
"format": "date-time",
"type": "string"
},
"id": {
"type": "string"
}
}
},
"OpenApiClientController.ClientCoOwner": {
"description": "Base REST model for client co owner.",
"type": "object",
"properties": {
"clientCoOwnerPhones": {
"description": "The list of related ClientCoOwnerPhone objects.",
"type": "array",
"items": {
"$ref": "#/$defs/OpenApiClientController.ClientCoOwnerPhone"
}
},
"clientId": {
"description": "Unique identifier representing the related Client entity. Also serves as the primary key for the co-owner.",
"type": "string"
},
"email": {
"description": "The co-owner's email address.",
"type": "string"
},
"emailDirectMessagingNotification": {
"description": "Flag indicating whether the co-owner accepts Email - Direct Messaging notifications.",
"type": "boolean"
},
"firstName": {
"description": "The co-owner's first name.",
"type": "string"
},
"lastName": {
"description": "The co-owner's last name.",
"type": "string"
},
"smsDirectMessagingNotification": {
"description": "Flag indicating whether the co-owner accepts SMS - Direct Messaging notifications.",
"type": "boolean"
},
"dateCreated": {
"format": "date-time",
"type": "string"
},
"dateUpdated": {
"format": "date-time",
"type": "string"
}
}
},
"OpenApiClientController.ClientCoOwnerPhone": {
"description": "ClientCoOwnerPhone REST model",
"type": "object",
"properties": {
"clientCoOwnerId": {
"description": "Unique identifier representing the related ClientCoOwner entity.",
"type": "string"
},
"clinicId": {
"description": "Unique identifier representing the related Clinic entity.",
"type": "string"
},
"country": {
"$ref": "#/$defs/OpenApiClientController.Country",
"description": "Object representing related Country entity."
},
"countryId": {
"format": "uuid",
"description": "Unique identifier representing the related Country entity.",
"type": "string"
},
"isPrimary": {
"description": "Flag indicating whether this instance is the primary phone number for the co-owner.",
"type": "boolean"
},
"phoneNumber": {
"description": "The phone number.",
"type": "string"
},
"phoneType": {
"$ref": "#/$defs/OpenApiClientController.PhoneType",
"description": "Object representing related PhoneType entity."
},
"phoneTypeId": {
"description": "Unique identifier representing the related PhoneType entity.",
"type": "string"
},
"dateCreated": {
"format": "date-time",
"type": "string"
},
"dateUpdated": {
"format": "date-time",
"type": "string"
},
"id": {
"type": "string"
}
}
},
"OpenApiClientController.ClientGender": {
"description": "ClientGender REST model.",
"type": "object",
"properties": {
"abrv": {
"description": "The abbreviated form of the gender.",
"type": "string"
},
"name": {
"description": "The full name of the gender.",
"type": "string"
},
"dateCreated": {
"format": "date-time",
"type": "string"
},
"dateUpdated": {
"format": "date-time",
"type": "string"
},
"id": {
"type": "string"
}
}
},
"OpenApiClientController.ClientInfo": {
"description": "ClientInfo REST model",
"type": "object",
"properties": {
"address": {
"description": "Address Line 1 should include the most essential details to identify a location clearly (e.g. street and number).",
"type": "string"
},
"address2": {
"description": "Address Line 2 should be used to capture additional information that doesn't fit into Address Line 1.\nThis line is essential for adding specific details to ensure accurate delivery or location identification (e.g. apt Apt 12C).",
"type": "string"
},
"city": {
"description": "City where the client resides.",
"type": "string"
},
"clientId": {
"description": "Unique identifier representing the related Client entity. Also serves as the primary key for the client info.",
"type": "string"
},
"clinicId": {
"description": "Unique identifier representing the related Clinic entity.",
"type": "string"
},
"driverLicenseExpirationDate": {
"format": "date-time",
"description": "Client's driver license expiration date",
"type": "string"
},
"driverLicenseNumber": {
"description": "Client's driver license number.",
"type": "string"
},
"driverLicenseState": {
"description": "State or province that issued the client's driver's license.",
"type": "string"
},
"state": {
"description": "Name of the state or province in the client's residential address.\nCan be represented either as an abbreviation (e.g., \"TX\") or as the full name (e.g., \"Texas\").",
"type": "string"
},
"zipCode": {
"description": "Postal or ZIP code in the client's residential address.",
"type": "string"
},
"dateCreated": {
"format": "date-time",
"type": "string"
},
"dateUpdated": {
"format": "date-time",
"type": "string"
}
}
},
"OpenApiClientController.ClientPhone": {
"description": "ClientPhone REST model",
"type": "object",
"properties": {
"country": {
"$ref": "#/$defs/OpenApiClientController.Country",
"description": "Object represeting related Country entity."
},
"countryId": {
"format": "uuid",
"description": "Unique identifier representing the related Country entity.",
"type": "string"
},
"isPrimary": {
"description": "Flag indicating whether this instance is the primary phone number for the client.",
"type": "boolean"
},
"phoneNumber": {
"description": "The client's phone number.",
"type": "string"
},
"phoneNumberName": {
"description": "Optional label/name for the phone number (e.g. \"Mobile\", \"Home\").",
"type": "string"
},
"phoneType": {
"$ref": "#/$defs/OpenApiClientController.PhoneType",
"description": "Object representing related PhoneType entity."
},
"phoneTypeId": {
"description": "Unique identifier representing the related PhoneType entity.",
"type": "string"
},
"dateCreated": {
"format": "date-time",
"type": "string"
},
"dateUpdated": {
"format": "date-time",
"type": "string"
},
"id": {
"type": "string"
}
}
},
"OpenApiClientController.ClientStatus": {
"description": "ClientStatus REST model",
"type": "object",
"properties": {
"abrv": {
"description": "Short unique identifier for the lookup.",
"type": "string"
},
"description": {
"description": "The description of the lookup entry.",
"type": "string"
},
"name": {
"description": "The name of the lookup entry.",
"type": "string"
},
"dateCreated": {
"format": "date-time",
"type": "string"
},
"dateUpdated": {
"format": "date-time",
"type": "string"
},
"id": {
"type": "string"
}
}
},
"OpenApiClientController.ClientType": {
"description": "ClientType REST model.",
"type": "object",
"properties": {
"isActive": {
"description": "Value indicating whether this client type is active.",
"type": "boolean"
},
"name": {
"description": "The name of the client type.",
"type": "string"
},
"dateCreated": {
"format": "date-time",
"type": "string"
},
"dateUpdated": {
"format": "date-time",
"type": "string"
},
"id": {
"type": "string"
}
}
},
"OpenApiClientController.Country": {
"description": "Country REST model.",
"type": "object",
"properties": {
"phoneCode": {
"description": "The country's phone code (e.g. 1 for the US)",
"type": "string"
},
"abrv": {
"description": "Short unique identifier for the lookup.",
"type": "string"
},
"description": {
"description": "The description of the lookup entry.",
"type": "string"
},
"name": {
"description": "The name of the lookup entry.",
"type": "string"
},
"dateCreated": {
"format": "date-time",
"type": "string"
},
"dateUpdated": {
"format": "date-time",
"type": "string"
},
"id": {
"type": "string"
}
}
},
"OpenApiClientController.PhoneType": {
"description": "PhoneType RESTModel",
"type": "object",
"properties": {
"abrv": {
"description": "Short unique identifier for the lookup.",
"type": "string"
},
"description": {
"description": "The description of the lookup entry.",
"type": "string"
},
"name": {
"description": "The name of the lookup entry.",
"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.
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"
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.