Breeder API

Your Breeder Profile — API reference

How to retrieve your Herpify profile, subscription status, and summary statistics via the Breeder API.

What it does

The profile endpoint returns everything that describes you as a seller on Herpify: your display name, bio, city, website, and avatar URL, plus your current subscription status, and a summary of your activity — how many listings you have, total views, favourites, and inquiries across all listings, and your average review rating.

Who can access it

This endpoint requires a Breeder plan subscription (active or trialling). Authenticate with a Bearer token in the `Authorization` header.

The request

Send a GET request to `/api/breeder/profile`. No parameters needed.

curl https://herpify.com/api/breeder/profile \
  -H "Authorization: Bearer hm_live_your_key_here"

What you'll get back

A single `data` object with your profile details, subscription info, and aggregate stats.

Example response

{
  "data": {
    "id": "clx1a2b3c4d5e6f7g",
    "displayName": "Outback Reptiles",
    "bio": "Specialising in Ball Pythons and Blue-Tongue Skinks. Perth, WA.",
    "city": "Perth",
    "website": "https://outbackreptiles.com.au",
    "avatarUrl": "https://cdn.herpify.com/avatars/outback.jpg",
    "subscription": {
      "tier": "BREEDER",
      "status": "ACTIVE",
      "currentPeriodEnd": "2026-04-21T00:00:00.000Z"
    },
    "stats": {
      "totalListings": 24,
      "totalViews": 3847,
      "totalFavourites": 312,
      "totalInquiries": 89,
      "averageRating": 4.9,
      "reviewCount": 47
    }
  }
}

Real-world example

Say you run a Google Sheet to track how your Herpify profile is growing month to month. You can call this endpoint once a day from a Google Apps Script, pull out `stats.totalViews`, `stats.averageRating`, and `stats.reviewCount`, and append them to a row in your sheet — giving you a historical trend without ever opening the website.

Was this article helpful?