> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rescueconsole.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Merge two records of one animal

> Keeps the record in the path and folds the record named by `loser_id` into it: its intakes, medical records, weights, adoptions, placements, behavior records, tags, notes, tasks, photos and documents move to the record you keep. Its pet ID is added to the kept record's other IDs, and its microchip and photo fill the kept record's where it has none (a different chip is added as an other ID). Where both have one of a kind there can be only one of at a time (a live adoption, an open quarantine), the other's stays with it. The other record is archived: a read of it answers 404 with `merged_into`. Refused for two species (400) and while either is in safekeeping (409). There is no route to undo a merge. Needs **admin** on Animals.



## OpenAPI

````yaml /api-reference/openapi.json post /api/animals/animals/{id}/merge
openapi: 3.1.0
info:
  title: RescueConsole API
  version: '2026-11-04'
  description: >-
    Your own organization's records, from your own software. There is no
    sandbox: every request goes to your live organization.
servers:
  - url: https://{organization}.rescueconsole.com
    description: Your own organization's address, the one you sign in at.
    variables:
      organization:
        default: your-rescue
        description: >-
          The first part of the address you sign in at. A key only works at the
          address of the organization it was made in.
security:
  - apiKey: []
tags:
  - name: Animals
    description: The animals in your care, and the ones you have placed.
  - name: Animal notes
    description: Notes written on an animal's record.
  - name: Animal weights
    description: An animal's weight readings, one per weighing.
  - name: Animal temperatures
    description: >-
      An animal's temperatures, as typed, with its exams' own read in and the
      species' usual range.
  - name: Animal readiness
    description: >-
      What an animal still needs before it goes on the public site, and
      publishing it.
  - name: Animal day
    description: What was done for an animal today, what is due, and feedings.
  - name: Animal medical records
    description: >-
      Vaccines, treatments, procedures, tests, exams and other medical records
      on one animal.
  - name: Animal placements
    description: The people an animal came from or has been placed with, over time.
  - name: Animal nutrition
    description: 'What an animal eats: its feeding list and its diet.'
  - name: Animal relationships
    description: Siblings, parents, offspring and bonded pairs.
  - name: Animal tags
    description: Your own short labels on an animal.
  - name: Breeds
    description: The breed or kind lists your intake form offers for each species.
  - name: Litters
    description: Litters, and the animals born into them.
  - name: Locations and housing
    description: >-
      The places animals are housed at each of your locations: campuses,
      buildings, rooms and cages, the tunnels that join cages into one space,
      and who is in each.
  - name: Foster homes
    description: >-
      The people who foster for you, what each home can take, and the animals
      offered to and placed with them.
  - name: Intakes
    description: >-
      How each animal arrived: the route in, who brought it, why it was given up
      and the state it came in.
  - name: Medical due
    description: >-
      Medical work that is outstanding across all your animals, and one medical
      record added to many animals at once.
  - name: Transports
    description: >-
      Transport runs: a chain of drives, each leg with its own driver, that
      moves animals from one place to another.
  - name: Animal calendar
    description: >-
      The dated things in animal care on one calendar: medical work due,
      adoptions, foster placements starting and ending, arrivals, and meet and
      greets.
  - name: Animal reports
    description: >-
      The operations report: intakes, outcomes, live release rate and the
      animals in your care, each figure with its own definition.
  - name: Costs
    description: >-
      What the rescue spends, on an animal or on itself: vet bills, food,
      supplies, boarding, each with its receipt in Documents, and what each
      animal has cost.
  - name: Rounds
    description: >-
      Daily rounds: a pass through every place an animal in care is housed, each
      place ticked as it is visited, signed off at the end.
  - name: Lost and found
    description: >-
      Reports of pets lost and found, sent by the public from the board on your
      site, read and put on the board by you.
  - name: Field visits
    description: >-
      Work out in the community: strays picked up, welfare checks, colony
      visits, pantry deliveries and owner support; and the TNR colonies a rescue
      cares for.
  - name: Field services
    description: >-
      For an organization that answers animal control calls: cases, with what
      was reported, where, the people and animals involved, the officer on it,
      every visit, call, notice and pickup, and the ordinances broken as
      warnings and citations, until each is closed with an outcome. Off until
      switched on, and the field team's.
  - name: Clinics
    description: >-
      Vaccine, microchip and spay or neuter clinics for the public's own pets:
      the pets on their owners' records, the clinic days, the services offered
      (sale items), and the appointments.
  - name: Behavior plans
    description: >-
      The work toward one goal for one animal: a goal, its phases, how success
      is measured, a lead and a review on a cadence, each review a task on the
      animal and each follow-up recorded. And the library a plan starts from.
  - name: Assessments
    description: >-
      Short assessments done on an animal as often as wanted, each scored
      question a line over time, and the ones your organization sets up. A
      question can fill the animal's Good with fields.
  - name: Enrichment and playgroups
    description: >-
      What an animal was given (walks, play, training, puzzles, time out of the
      kennel), its last time out, and playgroups: each dog's play rated and who
      it played with.
  - name: Behavior desk and case reviews
    description: >-
      What the behavior team has to do on one page, and case reviews: a serious
      outcome signed off by named people, decided by a person, never by the
      software.
  - name: Controlled drugs
    description: >-
      The controlled drugs given under your DEA registration: each bottle, every
      dose, waste and count, only added to. The printed, signed log stays the
      legal record.
  - name: Adoption applications
    description: >-
      Applications to adopt or foster, from first draft to a decision, and the
      adoption contract signed on an approved one.
  - name: Adoptions
    description: >-
      Animals that went home, what each adopter owes and has paid, and closing
      or reversing the adoption.
  - name: Signed contracts
    description: >-
      Contracts signed on an adoption, a foster placement or an intake, each
      kept exactly as it read when it was signed.
  - name: Contract templates
    description: >-
      The contracts your organization has people sign, with the merge fields
      that fill them in.
  - name: Reconciliations
    description: >-
      A payment processor's settlement lines, matched against the adoption
      payments you recorded.
  - name: Adoption holds
    description: >-
      An animal held for one person for a while, in Adoption Pending, with its
      fee taken as a deposit; and how long a hold lasts and what becomes of its
      fee.
  - name: Animal custom fields
    description: >-
      The extra fields your organization adds to animals, housing units and
      adoption applications.
  - name: Age groups
    description: >-
      What counts as a baby, an adult or a senior, per species, which fee rules
      and discounts read.
  - name: Animal statuses
    description: >-
      Your organization's status vocabulary for animal records, and what kind of
      status each one is.
  - name: Application stages
    description: >-
      The steps an adoption or foster application moves through before it is
      decided, in your organization's words.
  - name: Decision reasons
    description: >-
      Why an application is approved or denied, in your organization's words: a
      list for each decision.
  - name: Behavior attributes
    description: >-
      The catalog of behavioral traits, and where a trait with each name may be
      shown beyond the record.
  - name: Cage card templates
    description: >-
      The layouts your organization prints for the kennel door: paper, fields,
      photo and QR code.
  - name: Adoption fee schedules
    description: >-
      The rules that suggest an animal's adoption fee, and the discounts laid
      over them.
  - name: Medical catalog
    description: >-
      The diagnoses, tests, vaccines, treatments, procedures, conditions and
      medications your medical records pick from.
  - name: Medical protocols
    description: >-
      Your lists of what each species and age group is given, and when. Applying
      one adds ordinary medical records, due on their days.
  - name: Exam forms
    description: >-
      Forms filled on an animal in one go, such as an intake exam: each answer
      is saved as its own record (a weight, the microchip, medical records, one
      exam record of the findings, a note).
  - name: Clinic sheets
    description: >-
      One of your exam forms for the animals going to a clinic: printed with
      what is on file, typed in afterwards as a grid, and recorded as the form
      filled for each animal.
  - name: Handling levels
    description: >-
      Who may handle an animal, in your organization's words: anyone, trained
      volunteers and staff, or staff only.
  - name: Bites and quarantine
    description: An animal's bite reports, only added to, and the quarantine a bite starts.
  - name: Outcome reasons
    description: >-
      Why an animal was euthanized or died, in your organization's words, and
      whether one must be given.
  - name: Note types
    description: What an animal's notes are filed under, in your organization's words.
  - name: Text templates
    description: Words a note or a medical record's notes start from.
  - name: Jurisdictions
    description: >-
      The towns or counties your animals come from and go to, for a contract
      with each: the ZIP codes and town or city names that are each one, and the
      default a new arrival takes.
  - name: Foster reasons
    description: >-
      Why an animal goes to foster and why it came back: the reasons built in,
      the rescue's own, and whether each question is asked or required.
  - name: Certificate settings
    description: >-
      What a rabies or spay or neuter certificate prints beside its record: the
      rescue's text, whether the vet's signature prints, and each vet's license
      number and signature image.
  - name: People
    description: >-
      The people your organization deals with: adopters, donors, volunteers,
      fosters and everybody else.
  - name: Person notes
    description: Notes written on a person's record.
  - name: Person contacts
    description: >-
      A person's phone numbers and email addresses, one of each kind marked
      primary.
  - name: Person addresses
    description: A person's addresses, one of them primary.
  - name: Person tags
    description: Free-text labels on a person, added and removed one at a time.
  - name: People duplicates
    description: People who look like the same person entered twice, and merging them.
  - name: People custom fields
    description: The fields a person's record carries beyond the standard ones.
  - name: Pet food pantry
    description: >-
      Pet food given to people in your community: the households served and
      their pets, each visit and what went home, and what a month came to in
      pounds. Off until your organization switches it on, and what it keeps
      about the people it serves is your organization's choice.
  - name: Organizations
    description: >-
      The outside organizations your rescue deals with: veterinary practices,
      partner rescues, shelters, suppliers, employers and agencies.
  - name: Organization locations
    description: An organization's places, one of them the main one.
  - name: Affiliations
    description: >-
      Who works at, volunteers for or otherwise belongs to an organization, now
      or in the past.
  - name: Forms
    description: >-
      The forms your organization publishes, such as an adoption application or
      a volunteer sign-up, and the questions on them.
  - name: Submissions
    description: >-
      What people sent through your forms, and what your team does with each
      one.
  - name: Tasks
    description: >-
      To-dos, on a record or for the whole organization, narrowed to the records
      your key may read.
  - name: Calendar
    description: >-
      The dated work across your organization in one list, narrowed to the areas
      your key may read.
  - name: Activity
    description: >-
      What was created, changed and deleted in your organization, narrowed to
      the areas your key may read.
  - name: Shift schedules
    description: >-
      Schedules: the occasions shifts are grouped under, such as an adoption day
      or Saturday kennel cover.
  - name: Shift windows
    description: >-
      Shifts: a stretch of time at a place, with the volunteer roles it needs
      and how many of each (the address calls a shift a window).
  - name: Shift bookings
    description: >-
      Sign-ups: a person taking a role on a shift, giving it up, and the hours
      they worked.
  - name: Volunteers
    description: >-
      The people who volunteer: where each stands, what they have done, and
      where they would rather work.
  - name: Volunteer roles
    description: >-
      The jobs a volunteer can sign up for, such as Dog walker or Adoption
      counselor.
  - name: Volunteer qualifications
    description: 'Approvals: who may take which role, and at which location.'
  - name: Shift policies
    description: The rules you set for sign-ups and cancellations.
  - name: Shift calendar
    description: Schedules and shifts as calendar items for a date range.
  - name: Shift custom fields
    description: Your own fields on schedules, shifts and sign-ups.
  - name: Events
    description: >-
      The occasions your rescue hosts: adoption days, fundraisers, clinics and
      the rest.
  - name: Events calendar
    description: Your events between two days, as calendar entries.
  - name: Event tickets
    description: >-
      Tickets to an event, sold on its public page: the ticket types and codes,
      the guest list, and checking guests in at the door.
  - name: Campaigns
    description: >-
      Appeals you raise money for, each with its goal and what it has raised so
      far.
  - name: Donations
    description: 'Gifts of money: how much, from whom, and what they were given to.'
  - name: Donors
    description: The people who have given, with what each has given in all.
  - name: Wish list
    description: The things your rescue needs, and the deliveries that met them.
  - name: Auctions
    description: >-
      Gala auctions and the lots in them. An auction may be part of a campaign,
      so what it raises lands with the rest of that campaign's money, or stand
      on its own.
  - name: Fundraising custom fields
    description: Your organization's own fields on donations and campaigns.
  - name: Funds and appeals
    description: >-
      What a giver said their money is for, and what made them give: two
      different questions, kept apart.
  - name: Sales
    description: >-
      What crosses the counter that is not an adoption fee or a gift: the things
      you sell, and each sale by card, cash or check.
  - name: Message templates
    description: >-
      Saved wording your organization sends again and again, with merge fields
      filled from your records.
  - name: Sending
    description: >-
      Everything here sends real email from your organization, and none of it
      can be unsent.
  - name: Message log
    description: >-
      The email your organization has sent or tried to send, and what became of
      each message.
  - name: Conversations
    description: >-
      The email conversations in your organization's inboxes, and the records
      each one is about.
  - name: Inboxes
    description: >-
      The addresses your organization receives email at, and who may read each
      one.
  - name: Contact preferences
    description: >-
      Whether a person has asked not to be emailed, altogether or about one kind
      of message.
  - name: Suppressions
    description: >-
      Addresses no email goes to, because mail to them bounced or their owner
      asked not to be written to.
  - name: Sender and deliverability
    description: Who your organization's email goes out as, and how much of it arrives.
  - name: Registry flags
    description: >-
      Safety flags your organization files about a person or an animal, which
      other organizations using RescueConsole can see once the flag is vetted
      and shared.
  - name: Registry reviews
    description: >-
      Another organization's vote on a flag it did not file, which decides
      whether the flag becomes active or disputed.
  - name: Registry search
    description: >-
      The lookup by microchip number that anybody may make, with or without a
      key.
  - name: Registry marks
    description: >-
      Where a flag from another rescue matches one of YOUR records. A mark is a
      pointer with no narrative on it: it says what kind of thing was filed and
      which identifier matched, and reading the flag itself goes through the
      flag endpoints, which decide for themselves who may see what.
  - name: Status
    description: >-
      What the public status page at status.rescueconsole.com says, in
      RescueConsole's own shape. Public, like the status page itself: no key is
      needed.
paths:
  /api/animals/animals/{id}/merge:
    parameters:
      - name: id
        in: path
        required: true
        description: The animal record to keep.
        schema:
          type: string
    post:
      tags:
        - Animals
      summary: Merge two records of one animal
      description: >-
        Keeps the record in the path and folds the record named by `loser_id`
        into it: its intakes, medical records, weights, adoptions, placements,
        behavior records, tags, notes, tasks, photos and documents move to the
        record you keep. Its pet ID is added to the kept record's other IDs, and
        its microchip and photo fill the kept record's where it has none (a
        different chip is added as an other ID). Where both have one of a kind
        there can be only one of at a time (a live adoption, an open
        quarantine), the other's stays with it. The other record is archived: a
        read of it answers 404 with `merged_into`. Refused for two species (400)
        and while either is in safekeeping (409). There is no route to undo a
        merge. Needs **admin** on Animals.
      operationId: mergeAnimals
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - loser_id
              properties:
                loser_id:
                  type: string
                  description: >-
                    The record to fold in and archive. Not the same as the one
                    in the path.
            example:
              loser_id: b7c2e9d1-4a6f-4f3e-8d21-9e5a0c7b3f48
      responses:
        '200':
          description: The record you kept, and which one was merged into it.
          content:
            application/json:
              schema:
                type: object
                required:
                  - animal
                  - merged
                properties:
                  animal:
                    $ref: '#/components/schemas/Animal'
                  merged:
                    type: object
                    required:
                      - loser_id
                    properties:
                      loser_id:
                        type: string
        '400':
          $ref: '#/components/responses/Problem'
        '401':
          $ref: '#/components/responses/Problem'
        '403':
          $ref: '#/components/responses/Problem'
        '404':
          $ref: '#/components/responses/Problem'
        '409':
          $ref: '#/components/responses/Problem'
components:
  schemas:
    Animal:
      allOf:
        - $ref: '#/components/schemas/AnimalFields'
        - $ref: '#/components/schemas/AnimalUpdateOnlyFields'
        - type: object
          required:
            - id
            - species
            - intake_date
            - status
            - created_at
            - updated_at
          properties:
            id:
              type: string
            tenant_id:
              type: string
              description: Your organization's ID.
            pet_id:
              type:
                - string
                - 'null'
              description: >-
                The ID your organization's format gave it, such as A00042. Null
                when Pet IDs are switched off.
            species:
              $ref: '#/components/schemas/Species'
            intake_date:
              type: string
              format: date
            care_state:
              type: string
              enum:
                - in_care
                - placed
                - out_of_care
              description: What kind of status it is in.
            tags:
              type: array
              items:
                type: string
            transfer_id:
              type:
                - string
                - 'null'
              description: >-
                The transfer this animal came or went by, when it moved between
                partner rescues.
            transfer_partner_name:
              type:
                - string
                - 'null'
              description: The other rescue in that transfer.
            created_at:
              type: string
              format: date-time
            updated_at:
              type: string
              format: date-time
            outcome_reasons:
              type:
                - array
                - 'null'
              description: >-
                Why it was euthanized or died, in the words given then. Null for
                none.
              items:
                type: object
                required:
                  - id
                  - label
                properties:
                  id:
                    type: string
                  label:
                    type: string
            no_chip_reason:
              type:
                - string
                - 'null'
              description: >-
                Why it left with no microchip number, when it did. A chip number
                given later clears it.
            outcome_jurisdiction_id:
              type:
                - string
                - 'null'
              description: >-
                The jurisdiction its outcome went to, when one was given with
                the status.
            outcome_asilomar:
              type:
                - string
                - 'null'
              enum:
                - healthy
                - treatable_rehabilitatable
                - treatable_manageable
                - unhealthy_untreatable
                - null
              description: >-
                The Asilomar category with the outcome; null clears it. Any
                later change of status clears it, however the status was
                changed, so send it with the status or after it.
            missing_kind:
              type:
                - string
                - 'null'
              enum:
                - lost
                - stolen
                - null
              description: Lost or stolen, while it is Missing / Escaped.
    AnimalFields:
      type: object
      description: What can be written when an animal is taken in and changed afterwards.
      properties:
        name:
          type:
            - string
            - 'null'
          description: The internal name.
        public_name:
          type:
            - string
            - 'null'
          description: >-
            The external name: printed, and shown on your public site and
            listing sites. Null uses the internal name.
        breed:
          type:
            - string
            - 'null'
          description: >-
            The breed. For a small mammal, bird, reptile, fish, farm animal,
            large mammal or exotic, the KIND of animal: Guinea pig, Cockatiel.
        variety:
          type:
            - string
            - 'null'
          description: 'The breed or variety beside a kind: Abyssinian.'
          maxLength: 60
        sex:
          type:
            - string
            - 'null'
          enum:
            - male
            - female
            - unknown
            - null
        dob_estimate:
          type:
            - string
            - 'null'
          format: date
          description: The date of birth, or the best estimate of it.
        status:
          type: string
          description: One of your own status keys.
        current_location_unit_id:
          type:
            - string
            - 'null'
          description: 'Where the animal is housed: a location or unit ID. Null clears it.'
        microchip_number:
          type:
            - string
            - 'null'
        microchip_vendor:
          type:
            - string
            - 'null'
          maxLength: 60
        microchip_owner_registration:
          description: >-
            Where the OWNER has to register this chip themselves, when that is
            how the registry works, or null. Not a fault: the chip is fine and
            the registry is running. Derived on read from the registry name; it
            is not stored and cannot be written.
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/ChipOwnerRegistration'
        microchip_registry_verdict:
          description: >-
            What is known about the registry this chip is with, or null when
            there is nothing to say. Worked out on every read from the registry
            name and the chip number; it is not stored and cannot be written.
            Null is not a clean bill: it means the registry named is not one we
            hold anything about.
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/ChipRegistryVerdict'
        alt_names:
          type: array
          items:
            type: string
            maxLength: 60
          maxItems: 10
          description: >-
            Other names the animal is known by. Replaced whole when sent; blanks
            and repeats are dropped.
        size:
          type:
            - string
            - 'null'
          enum:
            - small
            - medium
            - large
            - extra_large
            - null
        color_primary:
          type:
            - string
            - 'null'
          description: Your own words.
          maxLength: 60
        color_secondary:
          type:
            - string
            - 'null'
          description: Your own words.
          maxLength: 60
        pattern:
          type:
            - string
            - 'null'
          description: Your own words.
          maxLength: 60
        coat_length:
          type:
            - string
            - 'null'
          description: Your own words.
          maxLength: 60
        intake_source:
          type:
            - string
            - 'null'
          enum:
            - stray
            - transfer
            - owner_surrender
            - field
            - born_in_care
            - adoption_return
            - seized
            - other
            - null
        primary_vet_organization_id:
          type:
            - string
            - 'null'
          description: 'The animal''s usual vet: an organization on file.'
        altered:
          type:
            - string
            - 'null'
          enum:
            - 'yes'
            - 'no'
            - unknown
            - null
          description: Spayed or neutered.
        altered_before_intake:
          type:
            - boolean
            - 'null'
          description: Whether it was spayed or neutered before it came to you.
        altered_on:
          type:
            - string
            - 'null'
          format: date
          description: When it was spayed or neutered.
        altered_veterinarian_person_id:
          type:
            - string
            - 'null'
          description: 'The vet who did it: a person on file.'
        altered_clinic_organization_id:
          type:
            - string
            - 'null'
          description: 'Where it was done: an organization on file.'
        adoption_fee_cents:
          type:
            - integer
            - 'null'
          description: >-
            The adoption fee, in cents. Null is no fee set, which is a different
            fact from a fee of 0.
          minimum: 0
        is_public:
          type: boolean
          description: >-
            Whether the animal itself is marked public. Your public site and
            listings show it only when its status is public too.
        health_status:
          type:
            - string
            - 'null'
          description: >-
            Health. When you write it, one of: healthy, minor_issue,
            under_treatment, recovering, chronic_condition, special_needs,
            critical, hospice. An older record may still hold words from before
            that list.
        description:
          type:
            - string
            - 'null'
          description: The description your public listing shows and a cage card can print.
        behavioral_traits:
          type: array
          items:
            type: string
          description: Replaced whole when sent.
        medical_flags:
          type: array
          items:
            type: string
          description: The animal's medical conditions, by name. Replaced whole when sent.
        custom_fields:
          type: object
          additionalProperties: true
          description: >-
            Your organization's own fields, by field key. Each value must suit
            its field. On a change, the keys you send are merged into what is
            stored, and a key sent as null is removed.
    AnimalUpdateOnlyFields:
      type: object
      description: >-
        What can be written only by changing an animal: the home it needs, its
        listing details and its outcome.
      properties:
        outcome_person_id:
          type:
            - string
            - 'null'
          description: >-
            Who the animal left with, such as its adopter: a person on file.
            Null clears it.
        outcome_date:
          type:
            - string
            - 'null'
          format: date
          description: When the animal left your care.
        good_with_children:
          $ref: '#/components/schemas/YesNo'
        min_child_age:
          type:
            - integer
            - 'null'
          description: >-
            The youngest child age, only when good_with_children is 1. Refused
            beside a good_with_children of 0.
          minimum: 0
          maximum: 18
        good_with_adults:
          type:
            - string
            - 'null'
          enum:
            - all
            - men_only
            - women_only
            - null
          description: Which adults the animal is good with. Null is not assessed.
        good_with_seniors:
          $ref: '#/components/schemas/YesNo'
        good_with_dogs:
          $ref: '#/components/schemas/YesNo'
        good_with_cats:
          $ref: '#/components/schemas/YesNo'
        good_with_farm_animals:
          $ref: '#/components/schemas/YesNo'
        good_with_small_animals:
          $ref: '#/components/schemas/YesNo'
        good_with_birds:
          $ref: '#/components/schemas/YesNo'
        needs_fenced_yard:
          $ref: '#/components/schemas/YesNo'
        ok_in_apartment:
          $ref: '#/components/schemas/YesNo'
        needs_experienced_adopter:
          $ref: '#/components/schemas/YesNo'
        max_hours_alone:
          type:
            - integer
            - 'null'
          description: The most hours the animal can be left alone.
          minimum: 0
          maximum: 24
        placement_notes:
          type:
            - string
            - 'null'
          description: What a home needs to know, in your own words.
        house_trained:
          $ref: '#/components/schemas/YesNo'
        crate_trained:
          $ref: '#/components/schemas/YesNo'
        leash_trained:
          $ref: '#/components/schemas/YesNo'
        declawed:
          $ref: '#/components/schemas/YesNo'
        fiv_positive:
          $ref: '#/components/schemas/YesNo'
          description: 1 is FIV positive, 0 is negative, and null is not tested.
        energy_level:
          type:
            - string
            - 'null'
          enum:
            - low
            - moderate
            - high
            - null
        indoor_outdoor:
          type:
            - string
            - 'null'
          enum:
            - indoor
            - both
            - outdoor
            - null
        available_date:
          type:
            - string
            - 'null'
          format: date
          description: The date the animal is available from.
        special_needs_description:
          type:
            - string
            - 'null'
          maxLength: 2000
        distinguishing_marks:
          type:
            - string
            - 'null'
          maxLength: 2000
        sponsorship_allowed:
          type: boolean
          description: >-
            Whether you take sponsors for this animal. True or false, never
            null.
        sponsorship_minimum_cents:
          type:
            - integer
            - 'null'
          description: The smallest sponsorship, in cents.
          minimum: 0
        sponsorship_details:
          type:
            - string
            - 'null'
          maxLength: 2000
        previous_id:
          type:
            - string
            - 'null'
          description: The animal's ID in another system.
          maxLength: 60
        photo_file_id:
          type:
            - string
            - 'null'
          description: >-
            The ID of the animal's profile photo. Null removes the photo. A
            photo is added from RescueConsole itself.
        status_review_on:
          type:
            - string
            - 'null'
          format: date
          description: >-
            When its status is looked at again. Set from the status's review
            days whenever the status changes; null clears it.
    Species:
      type: string
      enum:
        - dog
        - cat
        - rabbit
        - equine
        - small_mammal
        - large_mammal
        - bird
        - barnyard
        - fish
        - reptile
        - exotic
    ChipOwnerRegistration:
      type: object
      description: >-
        A registry that will only take a registration from the animal's owner.
        Nanochip ID is one: its chips are registered by their owners at Fetch
        ID, for security and privacy. Nothing can be sent on the owner's behalf,
        so the useful thing is to tell them.
      properties:
        vendor:
          type: string
          description: The registry as written on the animal's record.
        registry:
          type: string
          description: >-
            Where the owner registers, which is often a different name from the
            one on the chip.
        url:
          type: string
          format: uri
        adopter_note:
          type: string
          description: >-
            What the adopter is told, in their words. Shown on the page after an
            online adoption payment.
        organization_note:
          type: string
          description: >-
            What the rescue should know about their own part, including anything
            that cannot be undone.
    ChipRegistryVerdict:
      type: object
      description: >-
        What is known about the registry a chip is with. Worked out on read and
        never stored.
      properties:
        registry:
          type: string
          description: The registry this is about, as it is properly called.
        state:
          $ref: '#/components/schemas/ChipRegistryState'
        advice:
          type: string
          description: What to do about it, in plain words.
        matched_on:
          type: string
          description: >-
            name when the record names the registry, number when only the chip
            number suggested it. A number is a hint and is only used when no
            registry is written on the record.
          enum:
            - name
            - number
    YesNo:
      description: >-
        1 is yes, 0 is no, and null is NOT ASSESSED, which is a different fact
        from no.
      type:
        - integer
        - 'null'
      enum:
        - 1
        - 0
        - null
    ChipRegistryState:
      type: string
      description: >-
        closed: the registry is gone and the number resolves to nothing, so the
        animal needs registering again somewhere else. maybe_closed: the chip
        number was issued by a registry that has closed and no registry is
        written on the record, so it may be registered elsewhere and is worth
        looking up. moved: the registry still answers under another owner's
        name, the chip works, and only the name on your record is out of date.
      enum:
        - closed
        - maybe_closed
        - moved
  responses:
    Problem:
      description: What is wrong, in one sentence you can show to a person.
      content:
        application/json:
          schema:
            type: object
            required:
              - error
            properties:
              error:
                type: string
          example:
            error: house_trained must be 1, 0 or null (not assessed)
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: An API key from Settings, API keys. It starts with rc_live_.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.