Documentation & REST API Specification
Everything you need to build, integrate, and power modern breeder websites and CMS applications using the breeder.cloud REST API.
Developer & API Spec
Interactive API reference with all endpoints, request parameters, response schemas, and cURL snippets.
Enums & Data Types
Catalog of 25 domain enums with string literal values, allowed types, and descriptions.
Client Website Guides
Step-by-step tutorials for building custom frontend websites with Next.js, Astro, or Vue.
Quick Start
Make your first API request to fetch active animals or public website templates. Public endpoints require no authentication, while protected routes accept API tokens.
# 1. Fetch all active breeding animals
curl -X GET "https://breeder.cloud/api/v1/animals?status=ACTIVE" \
-H "Authorization: Bearer bc_live_your_token_here"
# 2. Fetch public organization website template
curl -X GET "https://breeder.cloud/api/v1/organizations/highland-kennels/template"
# 3. Fetch CMS homepage with sections & columns
curl -X GET "https://breeder.cloud/api/v1/organizations/highland-kennels/pages/home"// TypeScript Client Integration
interface Animal {
id: string;
name: string;
nameFull?: string;
sex?: "female" | "male" | "other" | "unknown";
status: "ACTIVE" | "INACTIVE" | "FUTURE" | "RETIRED";
}
async function getBreederAnimals(): Promise<Animal[]> {
const res = await fetch("https://breeder.cloud/api/v1/animals?status=ACTIVE", {
headers: {
Authorization: `Bearer ${process.env.BREEDER_CLOUD_API_TOKEN}`,
},
next: { revalidate: 60 }, // ISR caching for Next.js
});
if (!res.ok) throw new Error("Failed to fetch animals");
const json = await res.json();
return json.data;
}Platform Architecture & Core Modules
Animal Pedigrees & Lineage
Manage complete sire/dam relationships, multi-generation visual family trees, historical weight curves, DNA genetics, and localized health certifications.
Headless CMS & Dynamic Pages
Modular pages, customizable sections, responsive grid columns, photo galleries, navigation trees, and design theme tokens for frontend websites.
Health & Medical Catalog
Clinical diagnostic testing definitions (Genetic, Orthopedic, Ophthalmology, Cardiology) with multi-language translations and PDF attachments.
Inbound Lead Generation
Context-aware inquiry forms connecting public inquiries directly to specific animals, waiting lists, and sending automated notifications to breeders.
Machine-Readable API Specification Endpoints
Integrate with code generators, Postman, Swagger UI, or client websites via JSON endpoints.