Breeding model

Table of contents

  1. Introduction
  2. Fields
  3. Permissions
  4. API access

Introduction

Breedings capture parent pairings and litter-level metadata within a project. A breeding links one maternal subject (dam) and one paternal subject (sire), and can track dates and expected offspring details.

Fields

FieldDescription
Breeding nameName of the breeding (required; string; maximum length: 100 characters; must be unique within a project). Example: “B6J x PV-Cre Spring 2026”
ProjectProject the breeding belongs to (required). A breeding belongs to a single project, and both parent subjects must belong to this same project.
Maternal Subject (Dam)Female parent subject (required). Must have sex set to Female and must belong to the selected project.
Paternal Subject (Sire)Male parent subject (required). Must have sex set to Male, must belong to the selected project, and must be different from the maternal subject.
DescriptionRich text notes for breeding details. Useful for pairing observations, outcomes, and contextual notes.
TagsTags for organization and filtering. Tags are shared across users and models.
Birth dateDate of birth for offspring from this breeding (date format YYYY-MM-DD).
Breeding start dateDate the breeding started (pairing date; date format YYYY-MM-DD).
Breeding end dateDate the breeding ended (separation date; date format YYYY-MM-DD).
Weaning dateDate the litter was or will be weaned (date format YYYY-MM-DD).
Litter sizeExpected or actual number of offspring (positive integer).
Expected genotypeExpected genotype of offspring (string; maximum length: 100 characters).

Permissions

Breedings inherit permissions from their associated project.

Visit the permissions page to learn more.

API access

The API allows for programmable access to breedings, enabling you to read, edit, and delete breedings through the API. Learn more about the breedings’ fields and data structure on the Breedings API page.