> ## Documentation Index > Fetch the complete documentation index at: https://developer.vetcove.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a clinic client > Creates a new clinic client with the given information and, optionally, associated clinic patients. A **clinic client** represents a pet parent (pet owner) at a specific clinic location. Each clinic client belongs to exactly one clinic and can be associated with one or more clinic patients (pets). If the same person visits multiple clinics within the same organization, they will have a separate clinic client record at each location, linked by a shared organization client ID. ## OpenAPI ````yaml post /ext/v2/clinic-clients/ openapi: 3.1.0 info: description: '' title: NinjaAPI version: 2.0.0 servers: - url: https://connect.vetcove.com/ security: [] paths: /ext/v2/clinic-clients/: post: tags: - Clients And Patients summary: Create a clinic client description: >- Creates a new clinic client with the given information and, optionally, associated clinic patients. A **clinic client** represents a pet parent (pet owner) at a specific clinic location. Each clinic client belongs to exactly one clinic and can be associated with one or more clinic patients (pets). If the same person visits multiple clinics within the same organization, they will have a separate clinic client record at each location, linked by a shared organization client ID. operationId: clinic_clients_create parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/ExternalClinicClientCreateSchema' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/ExternalClinicClientDetailSchema' description: Created security: - ExternalAPIAuth: [] components: schemas: ExternalClinicClientCreateSchema: properties: client_notes: default: '' description: The notes on the client. title: Client Notes type: string clinic_id: description: The ID of the clinic which this clinic client belongs to. title: Clinic Id type: integer clinic_patients: anyOf: - items: $ref: '#/components/schemas/ExternalClinicClientCreatePatientSchema' type: array - type: 'null' description: A list of clinic patients associated with this clinic client. title: Clinic Patients email: default: '' description: The email address of the clinic client. format: email title: Email type: string first_name: description: The first name of the clinic client. title: First Name type: string last_name: description: The last name of the clinic client. title: Last Name type: string metadata: anyOf: - type: object - type: 'null' description: User-set metadata related to this client. title: Metadata phone_number: anyOf: - type: string - type: integer description: The phone number of the clinic client. title: Phone Number pim_id: default: '' description: The ID of the clinic client in the clinic's PIMS. title: Pim Id type: string primary_address: anyOf: - $ref: '#/components/schemas/ExternalClinicClientAddressCreateSchema' - type: 'null' description: The primary address of the clinic client. required: - clinic_id - first_name - last_name - phone_number title: ExternalClinicClientCreateSchema type: object ExternalClinicClientDetailSchema: properties: can_be_called: description: Whether the clinic can call the client. title: Can Be Called type: boolean client_notes: description: The notes on the client. title: Client Notes type: string clinic_id: description: The ID of the clinic this client belongs to. title: Clinic Id type: integer clinic_patients: $ref: '#/components/schemas/ExternalClinicClientDetailPatientSchemaList' description: A list of all clinic patients associated with this clinic client. created: description: The datetime this object was created. format: date-time title: Created type: string deleted: anyOf: - format: date-time type: string - type: 'null' description: The datetime this record was soft deleted. title: Deleted email: anyOf: - type: string - type: 'null' description: >- The primary email address for this client account. This is selected from the available contact methods across all ClientUsers. When updating via the Client update endpoint, changes are applied to the primary ClientUser. title: Email external_id: anyOf: - type: string - type: 'null' description: >- The ID from a clinic's legacy PIMS system, if the data was imported from there. title: External Id first_name: anyOf: - type: string - type: 'null' description: >- The first name of the primary clinic client user. For clinic clients with multiple clinic client users (has_multiple_users=true), this represents only the primary clinic client user's name. title: First Name has_multiple_users: description: >- Whether this client has multiple users (co-owners) associated with it. The first_name and last_name fields on this Client represent the primary ClientUser only. Use the /clinic-client-users/ endpoints to view and manage all ClientUsers for this Client. title: Has Multiple Users type: boolean has_unread_messages_for_clinic: description: >- Whether there are unread inbound messages from the client (for clinic's perspective) title: Has Unread Messages For Clinic type: boolean id: description: The ID of the clinic client title: Id type: integer is_active: description: Whether the client is active. title: Is Active type: boolean is_deleted: description: Whether this record is soft deleted or not. title: Is Deleted type: boolean is_email_unsubscribed: anyOf: - type: boolean - type: 'null' description: >- Whether the client has unsubscribed from marketing emails, if they have an email on file. A null value indicates they do not have an email on file. title: Is Email Unsubscribed is_subscribed: description: Whether the client is subscribed to receive info from the clinic. title: Is Subscribed type: boolean last_name: anyOf: - type: string - type: 'null' description: >- The last name of the primary clinic client user. For clinic clients with multiple clinic client users (has_multiple_users=true), this represents only the primary clinic client user's name. title: Last Name last_visit_date: anyOf: - format: date-time type: string - type: 'null' description: The date of the client's most recent appointment or invoice. title: Last Visit Date metadata: description: User-set metadata related to this client. title: Metadata type: object modified: description: >- The datetime this object was last modified; changes to related entities will not update this field. format: date-time title: Modified type: string organization_client_id: anyOf: - type: integer - type: 'null' description: The organization client ID corresponding to this clinic client. title: Organization Client Id phone_number: anyOf: - type: integer - type: 'null' description: >- The primary phone number for this client account. This is selected from the available contact methods across all ClientUsers. When updating via the Client update endpoint, changes are applied to the primary ClientUser. title: Phone Number pim_id: anyOf: - type: string - type: 'null' description: The ID of the clinic client in the clinic's PIMS. title: Pim Id primary_address: anyOf: - $ref: '#/components/schemas/ExternalAddressSchema' - type: 'null' description: The primary address of the clinic client. primary_client_user_id: anyOf: - type: integer - type: 'null' description: >- The ID of the primary ClientUser (account owner) for this client. This is the 'main' owner whose name is reflected in the Client's `first_name` and `last_name` fields. title: Primary Client User Id primary_payment_method_id: anyOf: - type: integer - type: 'null' description: The ID of the primary payment method of the clinic client title: Primary Payment Method Id sms_preference: $ref: '#/components/schemas/SMSPreference' description: >- Client's SMS preference: - `NA`: Not applicable or unknown. - `ALL`: Receive all SMS notifications. - `TRANSACTIONAL`: Only critical transactional notifications (e.g. password reset, onboarding, checkout). - `UNSUBSCRIBED`: Do not send any SMS messages. required: - created - modified - is_deleted - deleted - id - clinic_id - pim_id - organization_client_id - is_email_unsubscribed - is_active - external_id - can_be_called - is_subscribed - has_unread_messages_for_clinic - last_visit_date - client_notes - has_multiple_users - primary_client_user_id - clinic_patients - metadata - sms_preference title: ExternalClinicClientDetailSchema type: object ExternalClinicClientCreatePatientSchema: properties: allergies: anyOf: - type: string - type: 'null' default: '' description: The allergies of the clinic patient. title: Allergies birth_day: anyOf: - maximum: 31 minimum: 1 type: integer - type: 'null' description: The birth day of the clinic patient. title: Birth Day birth_month: anyOf: - maximum: 12 minimum: 1 type: integer - type: 'null' description: The birth month of the clinic patient. title: Birth Month birth_year: anyOf: - type: integer - type: 'null' description: The birth year of the clinic patient. title: Birth Year custom_breed: anyOf: - type: string - type: 'null' description: >- A custom breed declared for this patient. Useful for breeds which are not yet in our official listing of breeds. title: Custom Breed insurance: anyOf: - $ref: '#/components/schemas/ExternalClinicPatientInsuranceCreateSchema' - type: 'null' description: The insurance covering this clinic patient, if any. is_altered: anyOf: - type: boolean - type: 'null' description: >- Whether this patient is altered (spayed or neutered, as appropriate). Can be null if we do not know whether the patient is altered. title: Is Altered metadata: anyOf: - type: object - type: 'null' description: User-set metadata related to this client. title: Metadata microchip_number: anyOf: - type: string - type: 'null' description: The microchip number of the clinic patient. title: Microchip Number name: description: The name of the clinic patient. title: Name type: string pim_id: anyOf: - type: string - type: 'null' description: The ID of the clinic patient in the clinic's PIMS. title: Pim Id primary_breed: anyOf: - $ref: '#/components/schemas/PatientBreed' - const: '' type: string default: '' description: >- The primary breed of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint. title: Primary Breed secondary_breeds: default: [] description: >- The secondary breeds of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint. items: anyOf: - $ref: '#/components/schemas/PatientBreed' - const: '' type: string title: Secondary Breeds type: array sex: allOf: - $ref: '#/components/schemas/SexKind' default: UNKNOWN description: The sex of the clinic patient. species: anyOf: - $ref: '#/components/schemas/PatientKind' - const: '' type: string description: The species of the clinic patient. title: Species weight: anyOf: - type: number - type: 'null' description: The weight of the clinic patient, in pounds. title: Weight required: - name - species title: ExternalClinicClientCreatePatientSchema type: object ExternalClinicClientAddressCreateSchema: properties: address_one: description: The first line of the address. maxLength: 100 title: Address One type: string address_two: default: '' description: The second line of the address. maxLength: 100 title: Address Two type: string city: description: The city of the address. maxLength: 100 title: City type: string country: allOf: - $ref: '#/components/schemas/Countries' default: US description: The 2-letter code of the country of the address. county: default: '' description: The county of the address. maxLength: 100 title: County type: string name: default: '' description: The name of the address. maxLength: 100 title: Name type: string phone_number: anyOf: - type: integer - type: 'null' description: The phone number of the address. title: Phone Number state: anyOf: - $ref: '#/components/schemas/States' - const: '' type: string description: The 2-letter code of the state/province/region of the address. title: State zipcode: description: The zip code/postal code of the address. maxLength: 10 minLength: 5 title: Zipcode type: string required: - address_one - city - state - zipcode title: ExternalClinicClientAddressCreateSchema type: object ExternalClinicClientDetailPatientSchemaList: properties: data: description: A single page of data contained within this list. items: $ref: '#/components/schemas/ExternalClinicClientDetailPatientSchema' title: Data type: array has_more: default: false description: Whether there are more pages or data in this list. title: Has More type: boolean next_page: description: A URL linking to the next page of this list. title: Next Page type: string type: default: list description: Type of this object. Always `list`. title: Type type: string required: - data - next_page title: ExternalClinicClientDetailPatientSchemaList type: object ExternalAddressSchema: properties: address_one: description: The first line of the address. maxLength: 100 title: Address One type: string address_two: default: '' description: The second line of the address. maxLength: 100 title: Address Two type: string city: description: The city of the address. maxLength: 100 title: City type: string country: allOf: - $ref: '#/components/schemas/Countries' default: US description: The 2-letter code of the country of the address. county: default: '' description: The county of the address. maxLength: 100 title: County type: string id: description: The ID of the address. title: Id type: integer name: default: '' description: The name of the address. maxLength: 100 title: Name type: string phone_number: anyOf: - type: integer - type: 'null' description: The phone number of the address. title: Phone Number state: description: >- The 2-letter code of the state/province/region of the address. Legacy data could deviate from the 2-letter code convention. title: State type: string zipcode: description: The zip code/postal code of the address. maxLength: 10 title: Zipcode type: string required: - address_one - city - state - zipcode - id title: ExternalAddressSchema type: object SMSPreference: enum: - NA - ALL - TRANSACTIONAL - UNSUBSCRIBED title: SMSPreference type: string ExternalClinicPatientInsuranceCreateSchema: properties: custom_provider_name: default: '' description: >- A custom name of the insurance provider. This field should be populated when `provider_id` is not. This field represents an insurance provider that is not yet in our standard listing. title: Custom Provider Name type: string policy_number: description: The policy number of this clinic patient's insurance. title: Policy Number type: string provider_id: anyOf: - type: integer - type: 'null' description: >- The ID of the insurance provider backing this insurance, if it is one of the providers in our standard listing. title: Provider Id required: - policy_number title: ExternalClinicPatientInsuranceCreateSchema type: object PatientBreed: enum: - AFFENPINSCHER - AFGHAN_HOUND - AFRICAN_VILLAGE_DOG - AIREDALE_TERRIER - AKITA - AKITA_INU - JAPANESE_AKITA - ALASKAN_KLEE_KAI - ALASKAN_MALAMUTE - ALASKAN_TYPE_HUSKY - AMERICAN_BULLDOG - AMERICAN_ENGLISH_COONHOUND - REDTICK_COONHOUND - ENGLISH_COONHOUND - AMERICAN_ESKIMO_DOG - AMERICAN_FOXHOUND - AMERICAN_HAIRLESS_TERRIER - AMERICAN_LEOPARD_HOUND - AMERICAN_PIT_BULL_TERRIER - AMERICAN_STAFFORDSHIRE_TERRIER - AMERICAN_VILLAGE_DOG - AMERICAN_WATER_SPANIEL - ANATOLIAN_SHEPHERD_DOG - KANGAL - APPENZELLER_SENNENHUND - ARABIAN_VILLAGE_DOG - ARMENIAN_GAMPR - AUSTRALIAN_CATTLE_DOG - BLUE_HEELER - AUSTRALIAN_KELPIE - AUSTRALIAN_SHEPHERD - AUSTRALIAN_TERRIER - AZAWAKH - BARBET - BASENJI - BASSET_FAUVE_DE_BRETAGNE - BASSET_HOUND - BAVARIAN_MOUNTAIN_SCENT_HOUND - BAVARIAN_MOUNTAIN_HOUND - BEAGLE - BEARDED_COLLIE - BEAUCERON - BEDLINGTON_TERRIER - BELGIAN_LAEKENOIS - BELGIAN_MALINOIS - BELGIAN_SHEEPDOG - GROENENDAEL - BELGIAN_TERVUREN - BERGAMASCO_SHEEPDOG - BERGER_PICARD - BERNESE_MOUNTAIN_DOG - BICHON_FRISE - BIEWER_TERRIER - BLACK_RUSSIAN_TERRIER - BLACK_AND_TAN_COONHOUND - BLOODHOUND - BLUE_LACY - BLUE_PICARDY_SPANIEL - BLUETICK_COONHOUND - BOERBOEL - SOUTH_AFRICAN_MASTIFF - BOHEMIAN_SHEPHERD - BOLOGNESE - BORDER_COLLIE - BORDER_TERRIER - BORZOI - BOSTON_TERRIER - BOUVIER_DES_FLANDRES - BOXER - BOYKIN_SPANIEL - BRACCO_ITALIANO - BRAQUE_DAUVERGNE - BRAQUE_DU_BOURBONNAIS - BRAQUE_FRANCAIS_PYRENEAN - BRIARD - BRITTANY - BRUSSELS_GRIFFON - BULL_TERRIER - BULLDOG - ENGLISH_BULLDOG - BULLMASTIFF - CAIRN_TERRIER - CANAAN_DOG - CANADIAN_ESKIMO_DOG - CANE_CORSO - CANE_DI_FONNI - CARDIGAN_WELSH_CORGI - CAROLINA_DOG - AMERICAN_DINGO - CATAHOULA_LEOPARD_DOG - CAUCASIAN_OVCHARKA - CAUCASIAN_SHEPHERD_DOG - CAVALIER_KING_CHARLES_SPANIEL - CENTRAL_ASIAN_SHEPHERD_DOG - CENTRAL_ASIAN_VILLAGE_DOG - CENTRAL_AND_EAST_AFRICAN_VILLAGE_DOG - CESKY_FOUSEK - CESKY_TERRIER - CHESAPEAKE_BAY_RETRIEVER - CHIHUAHUA - CHINESE_CHONGQING_DOG - CHINESE_CRESTED - CHINESE_SHAR_PEI - CHINESE_VILLAGE_DOG - CHINOOK - CHOW_CHOW - CIMARRON_URUGUAYO - CIRNECO_DELL_ETNA - CLUMBER_SPANIEL - COCKER_SPANIEL - COLLIE - COLOMBIAN_FINO_HOUND - COTON_DE_TULEAR - COYOTE - CURLY_COATED_RETRIEVER - CZECHOSLOVAKIAN_VLCAK - DACHSHUND - DALMATIAN - DACHSHUND_STANDARD - DACHSHUND_MINIATURE - DANDIE_DINMONT_TERRIER - DANISH_SWEDISH_FARMDOG - DINGO - DOBERMAN_PINSCHER - DOGO_ARGENTINO - DOGUE_DE_BORDEAUX - FRENCH_MASTIFF - DRENTSCHE_PATRIJSHOND - DUTCH_SHEPHERD - EAST_ASIAN_VILLAGE_DOG - EASTERN_EUROPEAN_VILLAGE_DOG - ENGLISH_COCKER_SPANIEL - ENGLISH_FOXHOUND - ENGLISH_SETTER - ENGLISH_SHEPHERD - ENGLISH_SPRINGER_SPANIEL - ENGLISH_TOY_SPANIEL - ENTLEBUCHER_MOUNTAIN_DOG - EURASIER - EUROPEAN_VILLAGE_DOG - FIELD_SPANIEL - FILA_BRASILEIRO - FINNISH_LAPPHUND - FINNISH_SPITZ - FLAT_COATED_RETRIEVER - FORMOSAN_MOUNTAIN_DOG - TAIWAN_DOG - FRENCH_BULLDOG - FRENCH_SPANIEL - GERMAN_LONGHAIRED_POINTER - DEUTSCH_LANGHAAR - GERMAN_PINSCHER - GERMAN_SHEPHERD_DOG - GERMAN_SHORTHAIRED_POINTER - GERMAN_SPITZ - GERMAN_WIREHAIRED_POINTER - GIANT_SCHNAUZER - GLEN_OF_IMAAL_TERRIER - GOLDEN_RETRIEVER - GORDON_SETTER - GRAND_BASSET_GRIFFON_VENDEEN - GRAY_WOLF - GREAT_DANE - GREAT_PYRENEES - GREATER_SWISS_MOUNTAIN_DOG - GREENLAND_DOG - GREENLAND_SLEDGE_DOG - GREYHOUND - HAMILTONSTOVARE - HARRIER - HAVANESE - HOKKAIDO - HOVAWART - IBIZAN_HOUND - ICELANDIC_SHEEPDOG - INDIAN_INDIGENOUS_DOG - IRISH_RED_AND_WHITE_SETTER - IRISH_SETTER - IRISH_TERRIER - IRISH_WATER_SPANIEL - IRISH_WOLFHOUND - ISTRIAN_SHORTHAIRED_HOUND - ITALIAN_GREYHOUND - JAGDTERRIER - JAMTHUND - JAPANESE_CHIN - JAPANESE_SPITZ - JINDO - KAI_KEN - KARAKACHAN - KARELIAN_BEAR_DOG - KEESHOND - KERRY_BLUE_TERRIER - KISHU_KEN - KOMONDOR - KUVASZ - LABRADOR_RETRIEVER - LAGOTTO_ROMAGNOLO - LAKELAND_TERRIER - LANCASHIRE_HEELER - LAPPONIAN_HERDER - LEONBERGER - LEVRIERO_MERIDIONALE - LHASA_APSO - LLEWELLIN_SETTER - LOWCHEN - MALTESE - MANCHESTER_TERRIER_STANDARD - MANCHESTER_TERRIER_TOY - MAREMMA_SHEEPDOG - MARKIESJE - DUTCH_TULIP_HOUND - MASTIFF - ENGLISH_MASTIFF - MI_KI - MINIATURE_BULL_TERRIER - MINIATURE_PINSCHER - MINIATURE_SCHNAUZER - MINIATURE_AUSTRALIAN_SHEPHERD - MOUNTAIN_CUR - MUDI - MUNSTERLANDER_LARGE - MUNSTERLANDER_SMALL - MURRAY_RIVER_RETRIEVER - MURRAY_RIVER_CURLY_COATED_RETRIEVER - NEAPOLITAN_MASTIFF - NEDERLANDSE_KOOIKERHONDJE - NEW_GUINEA_SINGING_DOG - NEW_ZEALAND_HUNTAWAY - NEWFOUNDLAND - NORFOLK_TERRIER - NORRBOTTENSPETS - NORTHERN_EAST_AFRICAN_VILLAGE_DOG - NORWEGIAN_BUHUND - NORWEGIAN_ELKHOUND - NORWEGIAN_LUNDEHUND - NORWICH_TERRIER - NOVA_SCOTIA_DUCK_TOLLING_RETRIEVER - OLD_ENGLISH_SHEEPDOG - OTTERHOUND - PAPILLON - PEKINGESE - PEMBROKE_WELSH_CORGI - PERDIGUERO_DE_BURGOS - PERRO_DE_PRESA_CANARIO - PERUVIAN_INCA_ORCHID - PETIT_BASSET_GRIFFON_VENDEEN - PHARAOH_HOUND - PHU_QUOC_RIDGEBACK - PICARDY_SPANIEL - PLOTT - POINTER - ENGLISH_POINTER - POLISH_LOWLAND_SHEEPDOG - POLISH_TATRA_SHEEPDOG - POLYNESIAN_VILLAGE_DOG - POMERANIAN - TOY_POODLE - MINIATURE_POODLE - POODLE_STANDARD - PORTUGUESE_PODENGO - PORTUGUESE_PODENGO_PEQUENO - PORTUGUESE_POINTER - PORTUGUESE_WATER_DOG - PRAGUE_RATTER - PUDELPOINTER - PUG - PULI - PUMI - PUNGSAN - PYRENEAN_MASTIFF - PYRENEAN_SHEPHERD - RAT_TERRIER - REDBONE_COONHOUND - RHODESIAN_RIDGEBACK - ROTTWEILER - JACK_RUSSELL_TERRIER - RUSSIAN_TOY - RUSSIAN_TSVETNAYA_BOLONKA - RUSSELL_TERRIER - PARSON_RUSSELL_TERRIER - SAINT_BERNARD - SALUKI - SAMOYED - SARPLANINAC - SCHAPENDOES - SCHIPPERKE - SCOTTISH_DEERHOUND - SCOTTISH_TERRIER - SEALYHAM_TERRIER - SHETLAND_SHEEPDOG - SHIBA_INU - SHIH_TZU - SHIKOKU - SHILOH_SHEPHERD - SIBERIAN_HUSKY - SILKEN_WINDHOUND - MIXED_BREED - SILKY_TERRIER - SKYE_TERRIER - SLOUGHI - SLOVENSKY_CUVAC - SMOOTH_FOX_TERRIER - SOFT_COATED_WHEATEN_TERRIER - SPANISH_GALGO - SPANISH_MASTIFF - SPANISH_WATER_DOG - SPINONE_ITALIANO - STABYHOUN - STAFFORDSHIRE_BULL_TERRIER - STANDARD_SCHNAUZER - SUSSEX_SPANIEL - SWEDISH_LAPPHUND - SWEDISH_VALLHUND - TEDDY_ROOSEVELT_TERRIER - TERRIER_BRASILEIRO - THAI_BANGKAEW - THAI_RIDGEBACK - TIBETAN_MASTIFF - TIBETAN_SPANIEL - TIBETAN_TERRIER - TOSA_INU - TOY_FOX_TERRIER - TREEING_WALKER_COONHOUND - VIETNAMESE_VILLAGE_DOG - VIZSLA - VOLPINO_ITALIANO - WEIMARANER - WELSH_SHEEPDOG - WELSH_SPRINGER_SPANIEL - WELSH_TERRIER - WEST_HIGHLAND_WHITE_TERRIER - WEST_SIBERIAN_LAIKA - WESTERN_EUROPEAN_VILLAGE_DOG - WETTERHOUN - FRISIAN_WATER_DOG - WHIPPET - WHITE_SHEPHERD - WHITE_SWISS_SHEPHERD - BERGER_BLANC_SUISSE - WINDSPRITE - LONGHAIRED_WHIPPET - WIRE_FOX_TERRIER - WIREHAIRED_POINTING_GRIFFON - WIREHAIRED_VIZSLA - XOLOITZCUINTLI - MEXICAN_HAIRLESS - YAKUTIAN_LAIKA - YORKSHIRE_TERRIER - SILKEN_WINDSPRITE - GOLDENDOODLE - LABRADOODLE - BERNEDOODLE - AUSSIEDOODLE - SHEEPADOODLE - FEIST - MINIATURE_AMERICAN_SHEPHERD - CAVACHON - ARCTIC_FOX - FENNEC_FOX - GREY_FOX - RED_FOX - SWIFT_FOX - ABYSSINIAN - AMERICAN_BOBTAIL - AMERICAN_CURL - AMERICAN_SHORTHAIR - AMERICAN_WIREHAIR - BALINESE - BENGAL - BIRMAN - BOMBAY - BRITISH_SHORTHAIR - BURMESE - BURMILLA - CHARTREUX - COLORPOINT_SHORTHAIR - CORNISH_REX - DEVON_REX - EGYPTIAN_MAU - EUROPEAN_BURMESE - EXOTIC - HAVANA_BROWN - JAPANESE_BOBTAIL - KHAO_MANEE - KORAT - LAPERM - LYKOI - MAINE_COON - MANX - MUNCHKIN - NORWEGIAN_FOREST_CAT - OCICAT - ORIENTAL - PERSIAN - RAGAMUFFIN - RAGDOLL - RUSSIAN_BLUE - SCOTTISH_FOLD - SELKIRK_REX - SIAMESE - SIBERIAN - SINGAPURA - SOMALI - SPHYNX - TONKINESE - TOYBOB - TURKISH_ANGORA - TURKISH_VAN - DOMESTIC_SHORTHAIR_DSH - DOMESTIC_LONGHAIR_DLH - DOMESTIC_MEDIUMHAIR_DMH - HIMALAYAN - NEBELUNG - COLD_BLOOD - PINTO - PAINT - QUARTER_HORSE - SADDLEBRED - THOROUGHBRED - BELGIAN - GRADE - PONY - BELGIUM_WARMBLOOD - CLEVELAND_BAY - DONKEY - DUTCH_WARMBLOOD - HACKNEY - HAFLINGER - HANOVERIAN - IRISH_SPORTHORSE - KENTUCKY_MOUNTAIN_HORSE - MINIATURE_DONKEY - MULE - PERCHERON - ROCKY_MOUNTAIN_HORSE - SHETLAND_PONY - STANDARDBRED - SWEDISH_WARMBLOOD - AMERICAN_SADDLEBRED - APPALOOSA - ARABIAN - CLYDESDALE - MINIATURE_HORSE - MISSOURI_FOX_TROTTER - MORGAN - MUSTANG - PALAMINO - PERUVIAN_PASO_FINO - TENNESSEE_WALKER - WARMBLOOD - ANDALUSIAN - FRIESIAN - BURRO - ARAB_CROSS - GYPSY_VANNER - LIPPIZZAN - LUSITANO - QUARTER_HORSE_CROSS - SPANISH_BARB - THOROUGHBRED_CROSS - WARMBLOOD_CROSS - WELSH - AMERICAN_QUARTER_HORSE - ARDENNES - AUSTRALIAN_WARMBLOOD - AMERICAN_WARMBLOOD - BURMESE_HORSE - CASPIAN_HORSE - CORSICAN_HORSE - DANISH_WARMBLOOD - ESTONIAN_DRAFT - FLEUVE - OLDENBURG - SPOTTED_SADDLE_HORSE - IRISH_DRAFT - DRAFT - FJORD - BUDGIE - BLUE_FRONTED_AMAZON - MACAW - COCKATIEL - COCKATOO - ORANGE_WINGED_AMAZON - WHITE_FRONTED_AMAZON - YELLOW_NAPED_AMAZON - FISCHERS_LOVEBIRD - GREEN_WINGED_MACAW - SCARLET_MACAW - SENEGAL_PARROT - LORY - CONURE - PARROTLET - BLUE_AND_GOLD_MACAW - CHESTNUT_FRONTED_MACAW - HAHNS_MACAW - HYACINTH_MACAW - MILITARY_MACAW - NOBLE_MACAW - RED_BELLIED_MACAW - RED_SHOULDERED_MACAW - SEVERE_MACAW - AFRICAN_GREY - CONGO_AFRICAN_GREY - TIMNEH_AFRICAN_GREY - AMAZON - CUBAN_AMAZON - DOUBLE_YELLOW_HEADED_AMAZON - FINSCHS_AMAZON - GREEN_CHEEKED_AMAZON - HISPANIOLAN_AMAZON - LILAC_CROWNED_AMAZON - MEALY_AMAZON - MEXICAN_RED_HEAD_AMAZON - PUERTO_RICAN_AMAZON - RED_LORED_AMAZON - SPECTACLED_AMAZON - TUCUMAN_AMAZON - YELLOW_CROWNED_AMAZON - YELLOW_HEADED_AMAZON - BLACK_HEADED_CAIQUE - WHITE_BELLIED_CAIQUE - BLACK_CAPPED_CONURE - BLUE_CROWNED_CONURE - CITRON_CRESTED_COCKATOO - CORELLA - DUSKY_HEADED_CONURE - GALAH - GREEN_CHEEKED_CONURE - GOFFINS_COCKATOO - GREEN_CONURE - JENDAYA_CONURE - LEADBEATER_COCKATOO - MAROON_BELLIED_CONURE - MITRED_CONURE - MAJOR_MITCHELL_COCKATOO - MOLUCCAN_COCKATOO - NANDAY_CONURE - ORANGE_FRONTED_CONURE - PALM_COCKATOO - PAINTED_CONURE - PATAGONIAN_CONURE - ROSE_BREASTED_COCKATOO - SALMON_CRESTED_COCKATOO - SUN_CONURE - SULFUR_CRESTED_COCKATOO - UMBRELLA_COCKATOO - WHITE_EYED_CONURE - WHITE_COCKATOO - ECLECTUS - HAWKHEAD - LORIKEET - GOLDIES_LORIKEET - MUSK_LORIKEET - PERFECT_LORIKEET - RAINBOW_LORIKEET - BLACK_CAPPED_LORY - BLUE_STREAKED_LORY - CHATTERING_LORY - RED_LORY - LOVEBIRD - PEACHFACED_LOVEBIRD - PARROT - BROWN_HEADED_PARROT - CAPE_PARROT - GREY_HEADED_PARROT - JARDINES_PARROT - MEYERS_PARROT - RED_BELLIED_PARROT - PIONUS - BLUE_HEADED_PIONUS - BRONZE_WINGED_PIONUS - DUSKY_PIONUS - MAXIMILIANS_PIONUS - SCALY_HEADED_PIONUS - WHITE_CAPPED_PIONUS - AFRICAN_RINGNECK - ALEXANDRINE_PARAKEET - INDIAN_RINGNECK - MOUSTACH_PARAKEET - ROSE_BREASTED_PARAKEET - ROSE_RINGED_PARAKEET - MONK_QUAKER - ROSELLA - GREY_CHEEKED_PARAKEET - BOURKES_PARAKEET - REAGENT_PARAKEET - SPLENDID_PARAKEET - SUPERB_PARAKEET - ROCK_PEBBLER_PARAKEET - PARAKEET - YELLOW_COLLARED - CAIQUE - BARE_EYED_COCKATOO - DOMESTIC_DUCK - DUCK - MALLARD_DUCK - PEKIN_DUCK - DOMESTIC_GOOSE - GOOSE - BLACK_SWAN - MUTE_SWAN - SWAN - TRUMPTER_SWAN - WHISTLING_SWAN - WHOOPER_SWAN - HERON - IBIS - LOON - STORK - DOVE - MOURNING_DOVE - RING_NECK_DOVE - PIGEON - ROCK_DOVE - CHICKEN_HEN - CHICKEN - CHICKEN_ROOSTER - GROUSE - GUINEAFOWL - PARTRIDGE - PEACOCK - PEAFOWL - PEAHEN - PHEASANT - QUAIL - DOMESTIC_TURKEY - TURKEY - WILD_TURKEY - AFRICAN_CROWNED_CRANE - CRANE - SANDHILL_CRANE - WHOOPING_CRANE - BLACKBIRD - CROW - BENGALESE_FINCH - FINCH - GOLDFINCH - GOULDIAN_FINCH - HOUSE_FINCH - SOCIETY_FINCH - ZEBRA_FINCH - GRACKLE - MYNAH - RAVEN - ROBIN - PASSERINE - SONGBIRD - SPARROW - STARLING - CORMORANT - PELICAN - PHOENICOPTERIFORME_FLAMINGO - KEEL_BILLED_TOUCAN - TOUCAN - TOCO_TOUCAN - CONDOR - BALD_EAGLE - EAGLE - GOLDEN_EAGLE - FALCON - PEREGRINE - BAY_WINGED_HAWK - HAWK - HARRIS_HAWK - RED_TAIL_HAWK - KESTREL - OSPREY - BARN_OWL - BARRED_OWL - GREAT_GREY_OWL - GREAT_HORNED_OWL - OWL - SCREECH_OWL - SNOWY_OWL - TURKEY_VULTURE - VULTURE - AFRICAN_PENGUIN - JACKASS_PENGUIN - PENGUIN - HORNBILL - ROOSTER - CANARY - HOLSTEIN - BLACK_ANGUS - CHAROLAIS - GELBVIEH - HEREFORD - HIGHLANDS - LIMOUSIN - RED_ANGUS - SIMMENTAL - TEXAS_LONGHORN - KUDU - BISON - ANGORA - DUTCH_BELTED_RABBIT - DWARF_RABBIT - FLEMISH_RABBIT - LION_HEAD_RABBIT - LOP_EARED_RABBIT - NEW_ZEALAND_WHITE_RABBIT - MINI_LOP - REX_RABBIT - DOMESTIC_RABBIT - NETHERLAND_DWARF - POLISH - CALIFORNIAN - JERSEY_WOOLY - HOTOT - MINI_REX - HOLLAND_LOP - FRENCH_LOP - SATIN - ENGLISH_SPOT - NEW_ZEALAND - CHECKERED - HARLEQUIN - CHINCHILLA - CHINESE_STRIPED_HAMSTER - DEGU - DUPRASI_FAT_TAILED_GERBIL - GOLDEN_SYRIAN_HAMSTER - GUINEA_PIG - JIRD_GERBIL - MOUSE - NMRI_MOUSE - PRAIRIE_DOG - RAT - RUSSIAN_DWARF_HAMSTER - SPRAGUE_DAWLEY_RAT - SQUIRREL - SQUIRREL_GREY_BLACK - BEAVER - PORCUPINE - CAPYBARA - CAVY - CHIPMUNK - BEARDED_DRAGON - BOA_CONSTRICTOR - BOA - EMERALD_TREE_BOA - RED_TAILED_BOA - ALLIGATOR - CAIMAN - CROCODILE - CHAMELEON - JACKSONS_CHAMELEON - PANTHER_CHAMELEON - REUNION_ISLAND_CHAMELEON - VEILED_CHAMELEON - CRESTED_GECKO - GECKO - LEOPARD_GECKO - NEW_CALEDONIAN_GECKO - GREEN_IGUANA - IGUANA - KOMODO_DRAGON - LIZARD - DUMERILS_MONITOR - MONITOR - SAVANNA_MONITOR - WATER_MONITOR - WHITE_THROATED_MONITOR - ASIAN_ROCK_PYTHON - BALL_PYTHON - BURMESE_PYTHON - CARPET_PYTHON - DIAMOND_PYTHON - PYTHON - ROYAL_PYTHON - TREE_PYTHON - SKINK - TEGU - SNAKE - CORN_SNAKE - GARTER_SNAKE - GOPHER_SNAKE - HOG_NOSED_SNAKE - KING_SNAKE - MILK_SNAKE - PINE_SNAKE - RAT_SNAKE - RATTLESNAKE - VIPER - TORTOISE - ALDABRA_TORTOISE - AFRICAN_SPURRED_TORTOISE - DESERT_TORTOISE - EGYPTIAN_TORTOISE - GALAPAGOS_TORTOISE - GOPHER_TORTOISE - GREEK_TORTOISE - LEOPARD_TORTOISE - RUSSIAN_TORTOISE - STAR_TORTOISE - SULCATA_TORTOISE - CHERRY_HEAD_TORTOISE - RED_FOOTED_TORTOISE - YELLOW_FOOTED_TORTOISE - ATLANTIC_GREEN_TURTLE - ATLANTIC_RIDLEY_TURTLE - AFRICAN_SIDE_NECK_TURTLE - BOX_TURTLE - DIAMONDBACK_TERRAPIN - LOGGERHEAD_TURTLE - PAINTED_TURTLE - RED_EAR_SLIDER_TURTLE - TURTLE - SLIDER - SNAPPING_TURTLE - YELLOW_BELLIED_SLIDER - SPINY_TAILED_LIZARD - UROMASTYX - AUSTRALIAN_WATER_DRAGON - CHINESE_WATER_DRAGON - FRILLED_DRAGON - WATER_DRAGON - SERRATED_FOREST_HINGEBACK_TORTOISE - WOOD_TURTLE - ANOLE - FALSE_CHAMELEON - ALLIGATOR_LIZARD - AXOLOTL - FROG - MUD_PUPPY - SALAMANDER - TOAD - TREE_FROG - PACMAN_FROG - BULL_FROG - AFRICAN_DWARF_FROG - AFRICAN_CLAWED_FROG - GOLDFISH - KOI - EEL - RAY - SHARK - GOTTINGEN_MINI - COMMERCIAL_CROSS - LARGE_WHITE_X - HANFORD - MINI_PIG - POT_BELLIED_PIG - SINCLAIR - YORKSHIRE_X - YUCATAN - YUCATAN_MINI - AFRICANBUSH_PIG - BABIRUSA_PIG - CWARTHOG_PIG - DOMESTIC_PIG - YORKSHIRE - HAMPSHIRE_PIG - VIETNAMESE_POTBELLIED_PIG - WHITE_YORKSHIRE_LANDRACE - ALPINE_X - ALPINE - BOER_X - BOER - CASHMERE - LA_MANCHA - NUBIAN - NIGERIAN_DWARF - OBERHASLI - NUBIAN_X - PYGMY_GOAT - PYGORA - SAANEN - TOGGENBURG - DOMESTIC_GOAT - ANGORA_GOAT - ROCKY_MOUNTAIN_GOAT - BARBADO - BORDER_LEICESTER - BIGHORN_SHEEP - DORSET - CHEVIOT - DORSET_X - HAMPSHIRE_SHEEP - MERINO - SHETLAND - SUFFOLK_X - SUFFOLK - DOMESTIC_SHEEP - DALL_SHEEP - LLAMA - ALPACA - CAMEL - ALPACA_HUACAYA - ALPACA_SURI - ARABIAN_DROMEDARIAN_CAMEL - BACTRIAN_CAMEL - EMU - OSTRICH - SUGAR_GLIDER - OPOSSUM - FERRET - WEASEL - MINK - ELK - DEER - RACCOON - COATI - HEDGEHOG - SKUNK - UNKNOWN title: PatientBreed type: string SexKind: enum: - MALE - FEMALE - UNKNOWN title: SexKind type: string PatientKind: enum: - CANINE - FELINE - EQUINE - AVIAN - BOVINE - FERRET - RABBIT - RODENT - REPTILE - AMPHIBIAN - FISH - PORCINE - CAPRINE - SHEEP - CAMELID - RATITE - MARSUPIAL - MUSTELID - CERVID - PROCYONIDAE - ERINACEIDAE - MEPHITIDAE - OTHER - UNSPECIFIED title: PatientKind type: string Countries: enum: - CA - US - AS - GU - MP - PR - VI title: Countries type: string States: enum: - AL - AK - AS - AZ - AR - CA - CO - CT - DE - DC - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY - AB - BC - MB - NB - NL - NS - NT - NU - 'ON' - PE - QC - SK - YT title: States type: string ExternalClinicClientDetailPatientSchema: properties: allergies: description: The allergies of the clinic patient. title: Allergies type: string birth_day: anyOf: - maximum: 31 minimum: 1 type: integer - type: 'null' description: The birth day of the clinic patient. title: Birth Day birth_month: anyOf: - maximum: 12 minimum: 1 type: integer - type: 'null' description: The birth month of the clinic patient. title: Birth Month birth_year: anyOf: - type: integer - type: 'null' description: The birth year of the clinic patient. title: Birth Year clinic_client_id: description: >- The ID of the clinic client which this clinic patient is associated with. title: Clinic Client Id type: integer custom_breed: anyOf: - type: string - type: 'null' description: >- A custom breed declared for this patient. Useful for breeds which are not yet in our official listing of breeds. title: Custom Breed id: description: The ID of the clinic patient. title: Id type: integer image_url: anyOf: - type: string - type: 'null' description: >- A pre-signed S3 URL good for 24 hours after request to the patient's profile picture, if any. title: Image Url insurance: anyOf: - $ref: '#/components/schemas/ExternalClinicPatientInsuranceSchema' - type: 'null' description: The insurance covering this clinic patient, if any. is_active: description: >- Whether the clinic patient is actively associated with this clinic client or not. title: Is Active type: boolean is_alive: description: Whether this patient is alive. title: Is Alive type: boolean is_altered: anyOf: - type: boolean - type: 'null' description: >- Whether this patient is altered (spayed or neutered, as appropriate). Can be null if we do not know whether the patient is altered. title: Is Altered is_deactivated: description: Whether this patient has been marked as deactivated. title: Is Deactivated type: boolean is_legacy_deactivated: description: >- Whether this patient was marked as deactivated in the clinic's legacy PIMS. title: Is Legacy Deactivated type: boolean is_surrendered: description: Whether this patient has been surrendered by all related clients. title: Is Surrendered type: boolean name: description: The name of the clinic patient. title: Name type: string organization_patient_id: anyOf: - type: integer - type: 'null' description: The organization patient ID corresponding to this clinic patient. title: Organization Patient Id pim_id: anyOf: - type: string - type: 'null' description: The ID of the clinic patient in the clinic's PIMS. title: Pim Id primary_breed: anyOf: - $ref: '#/components/schemas/PatientBreed' - const: '' type: string description: >- The primary breed of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint. title: Primary Breed secondary_breeds: description: >- The secondary breeds of the clinic patient. This field must be populated with a breed applicable to the species of this patient. To see which breeds are applicable to each species, reference the patient breeds endpoint. items: anyOf: - $ref: '#/components/schemas/PatientBreed' - const: '' type: string title: Secondary Breeds type: array sex: $ref: '#/components/schemas/SexKind' description: The sex of the clinic patient. species: anyOf: - $ref: '#/components/schemas/PatientKind' - const: '' type: string description: The species of the clinic patient. title: Species weight: anyOf: - type: number - type: 'null' description: The weight of the clinic patient, in pounds. title: Weight required: - id - name - species - pim_id - weight - sex - birth_month - birth_day - birth_year - clinic_client_id - is_active - organization_patient_id - primary_breed - secondary_breeds - custom_breed - allergies - is_altered - image_url - is_alive - is_surrendered - is_deactivated - is_legacy_deactivated title: ExternalClinicClientDetailPatientSchema type: object ExternalClinicPatientInsuranceSchema: properties: custom_provider_name: description: >- A custom name of the insurance provider. This field should be populated when `provider_id` is not. This field represents an insurance provider that is not yet in our standard listing. title: Custom Provider Name type: string policy_number: description: The policy number of this clinic patient's insurance. title: Policy Number type: string provider_id: anyOf: - type: integer - type: 'null' description: >- The ID of the insurance provider backing this insurance, if it is one of the providers in our standard listing. title: Provider Id required: - provider_id - custom_provider_name - policy_number title: ExternalClinicPatientInsuranceSchema type: object securitySchemes: ExternalAPIAuth: scheme: bearer type: http ````