> ## 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.

# Preview the adoption contract

> The adoption contract as it would read for these animals, and what is still to answer, without recording anything. Checked exactly as signing is, except that missing answers and unfilled merge fields are reported rather than refused. Only on an approved application. Needs **write** on Animals.



## OpenAPI

````yaml /api-reference/openapi.json post /api/animals/applications/{id}/contract/preview
openapi: 3.1.0
info:
  title: RescueConsole API
  version: '2026-09-19'
  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 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: 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: 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: Behaviour attributes
    description: >-
      The catalogue of behavioural 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 catalogue
    description: >-
      The diagnoses, tests, vaccines, treatments, procedures, conditions and
      medications your medical records pick from.
  - 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: 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: 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: Fundraising custom fields
    description: Your organization's own fields on donations and campaigns.
  - 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.
paths:
  /api/animals/applications/{id}/contract/preview:
    parameters:
      - name: id
        in: path
        required: true
        description: The application's ID.
        schema:
          type: string
    post:
      tags:
        - Adoption applications
      summary: Preview the adoption contract
      description: >-
        The adoption contract as it would read for these animals, and what is
        still to answer, without recording anything. Checked exactly as signing
        is, except that missing answers and unfilled merge fields are reported
        rather than refused. Only on an approved application. Needs **write** on
        Animals.
      operationId: previewApplicationContract
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContractAdoptionDraft'
            example:
              template_id: e1d2c3b4-a596-4877-8a9b-0c1d2e3f4a5b
              animal_ids:
                - 0c9d8e7f-6a5b-4c3d-9e1f-0a9b8c7d6e5f
              answers:
                media_release: true
                payment:
                  method: venmo
                  instructions: Send $150 to @ContosoRescue
                approver_person_id: 5d4c3b2a-1f0e-4d9c-8b7a-6f5e4d3c2b1a
                completed_where:
                  kind: event
                  label: Adoption day at Contoso Pet Supply
              adopted_on: '2026-09-18'
              signer_name: Dana Whitfield
      responses:
        '200':
          description: The contract as it would read.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ContractPreview'
                  - type: object
                    required:
                      - missing_answers
                      - asks
                      - fee_cents
                    properties:
                      missing_answers:
                        type: array
                        items:
                          type: string
                          enum:
                            - media_release
                            - payment
                            - approver
                            - completed_where
                        description: What the template asks that is not answered yet.
                      asks:
                        type: array
                        items:
                          type: string
                          enum:
                            - media_release
                            - payment
                            - approver
                            - completed_where
                        description: What the template asks.
                      fee_cents:
                        type: integer
                        description: Every animal's fee together.
                      decided_by_person_id:
                        type:
                          - string
                          - 'null'
                        description: Who approved the application.
        '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:
    ContractAdoptionDraft:
      type: object
      required:
        - template_id
        - animal_ids
      properties:
        template_id:
          type: string
          description: An active adoption contract, offered for these animals.
        animal_ids:
          type: array
          items:
            type: string
          minItems: 1
          maxItems: 10
          description: >-
            The animals going home, in the order the contract names them. They
            need not be the animals applied for, and none may already have an
            adoption that is not reversed.
        fees:
          type: object
          description: >-
            By animal ID, a fee other than the usual: `{ "fee_cents": 0 }` for
            another amount, or `{ "apply_discounts": false }` for the adoption
            fee with no discounts. An animal left out goes home at its adoption
            fee less any of your discounts that apply.
          additionalProperties:
            type: object
            properties:
              fee_cents:
                type: integer
                minimum: 0
              apply_discounts:
                type: boolean
                enum:
                  - false
        answers:
          $ref: '#/components/schemas/ContractAnswers'
        adopted_on:
          type: string
          format: date
          description: The adoption day, which `{{date}}` prints. Today unless you say.
        signer_name:
          type: string
          description: The name the adopter types. It fills `{{signer_name}}`.
    ContractPreview:
      type: object
      required:
        - body
        - unresolved_fields
        - values
      properties:
        body:
          type: string
          description: The contract as it would read.
        body_blocks:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/ContractDocumentBlock'
        unresolved_fields:
          type: array
          items:
            type: string
          description: >-
            Merge fields nothing fills. A contract with any is refused at
            signing.
        values:
          type: object
          additionalProperties:
            type: string
          description: Each merge field and what it filled in.
    ContractAnswers:
      type: object
      properties:
        media_release:
          type: boolean
          description: >-
            Whether the adopter agrees to the media release. Without it, the
            application's own answer is used when it has one.
        payment:
          type: object
          required:
            - method
          properties:
            method:
              type: string
              enum:
                - card_link
                - cashapp
                - venmo
                - paypal
                - zelle
                - cash
                - check
                - other
              description: >-
                How the adopter pays, printed in words: card_link prints as
                Card, with the payment link we send. Signing does not send a
                link.
            instructions:
              type: string
              description: How to complete the payment.
              maxLength: 1000
        approver_person_id:
          type: string
          description: >-
            The person approving the contract: somebody who can sign in to your
            organization. The contract prints their name.
        completed_where:
          type: object
          required:
            - kind
          properties:
            kind:
              type: string
              enum:
                - location
                - event
                - foster_home
                - remote
            id:
              type: string
              description: The location, event or foster home, for your own reference.
            label:
              type: string
              description: >-
                Where it was completed, as the contract will say it. Required
                unless remote.
              maxLength: 200
      description: >-
        The answers to what the template asks at signing. Answer what it asks;
        anything else is left out of the contract.
    ContractDocumentBlock:
      type: object
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - p
            - ul
            - ol
            - h
            - quote
            - hr
            - table
            - img
        runs:
          type: array
          items:
            $ref: '#/components/schemas/ContractTextRun'
          description: For p, h and quote.
        items:
          type: array
          items:
            type: array
            items:
              $ref: '#/components/schemas/ContractTextRun'
          description: 'For ul and ol: one list of runs per item, 100 items at most.'
        level:
          type: integer
          enum:
            - 1
            - 2
            - 3
          description: For h.
        rows:
          type: array
          items:
            type: array
            items:
              type: array
              items:
                $ref: '#/components/schemas/ContractTextRun'
          description: >-
            For table: rows of cells of runs, the first row the header. 50 rows
            and 10 cells at most.
        src:
          type: string
          description: >-
            For img: a PNG, JPEG, GIF or WebP image carried as a data: address,
            about 300 KB at most.
        alt:
          type: string
          description: 'For img: what the image shows.'
          maxLength: 200
      description: >-
        One block of a formatted document: a paragraph (p), a bulleted or
        numbered list (ul, ol), a heading (h), a quotation (quote), a dividing
        line (hr), a table, or an image (img). A document holds 200 blocks and 4
        images at most.
    ContractTextRun:
      type: object
      required:
        - text
      properties:
        text:
          type: string
          description: The words. A newline is a line break.
        bold:
          type: boolean
        italic:
          type: boolean
        underline:
          type: boolean
        strike:
          type: boolean
          description: Struck through.
        href:
          type: string
          description: 'A link: an https, http or mailto address.'
      description: A run of text in one style.
  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_.

````