REST API Specification & Reference

{
  "success": true,
  "data": [
    {
      "id": "cly1abc1230001xyz",
      "name": "Bella",
      "nameFull": "Bella of Highland Kennels",
      "sex": "female",
      "raceName": "Golden Retriever",
      "racePlural": "Golden Retrievers",
      "colorName": "Golden Sable",
      "status": "ACTIVE",
      "forBreeding": true,
      "archived": false,
      "dateOfBirth": "2023-04-12T00:00:00.000Z",
      "microchipId": "528140000123456",
      "registrationId": "NHSB-3289104",
      "motherAssociationId": "ALAEU-M-9988",
      "fatherAssociationId": "ALAEU-F-7766",
      "image": "https://r2.breeder.cloud/animals/bella.webp",
      "excerpt": "Top-ranked female with complete health test clearance.",
      "certificationNumbers": [
        {
          "id": "cly_acn_001",
          "animalId": "cly1abc1230001xyz",
          "certificationId": "cly_cert_alaeu",
          "identificationNumber": "ALAEU-12345",
          "certification": {
            "id": "cly_cert_alaeu",
            "title": "ALAEU (Australian Labradoodle Association Europe)",
            "type": "ASSOCIATION",
            "hasIdentificationSystem": true
          }
        }
      ],
      "preset": {
        "id": "cly_preset_dog",
        "name": "Golden Retriever",
        "namePlural": "Golden Retrievers",
        "breed": "Golden Retriever",
        "breedPlural": "Golden Retrievers",
        "animal": "Dog",
        "animalPlural": "Dogs"
      }
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  }
}

{
  "success": true,
  "data": {
    "id": "tmpl_123",
    "organizationId": "cly_org_highland",
    "name": "Default Template",
    "favicon": "https://r2.breeder.cloud/favicons/kennel-icon.png",
    "theme": "modern",
    "primaryColor": "#059669",
    "secondaryColor": "#0284c7",
    "fontFamily": "Inter, sans-serif",
    "borderRadius": "md",
    "headingFont": "Playfair Display",
    "bodyFont": "Inter",
    "h1Color": "#064e3b",
    "bodyTextColor": "#334155",
    "linkTextColor": "#059669",
    "headerStyle": "sticky",
    "footerStyle": "columns",
    "defaultLanguage": "en",
    "supportedLanguages": [
      "en",
      "nl"
    ],
    "defaultBreed": "Golden Retriever",
    "defaultBreedPlural": "Golden Retrievers",
    "defaultPresetId": "cly_preset_dog",
    "resolvedColors": {
      "primary": {
        "hex": "#059669",
        "rgb": "5 150 105",
        "className": "bg-emerald-600"
      },
      "secondary": {
        "hex": "#0284c7",
        "rgb": "2 132 199",
        "className": "bg-sky-600"
      }
    },
    "resolvedTextColors": {
      "h1": {
        "hex": "#064e3b",
        "rgb": "6 78 59",
        "className": "text-emerald-900"
      },
      "body": {
        "hex": "#334155",
        "rgb": "51 65 85",
        "className": "text-slate-700"
      }
    },
    "resolvedGoogleFonts": {
      "headingFont": "Playfair Display",
      "bodyFont": "Inter",
      "fonts": [
        "Inter",
        "Playfair Display"
      ]
    }
  }
}