Breeder API

Breeder API — notifications

Read and manage your Herpify notifications via the Breeder API.

List notifications

Returns your notifications ordered by recency. Filter by `seen` status to fetch only unread notifications.

ParameterTypeRequiredDescription
seen"true" | "false"OptionalFilter by seen status. Omit to return all notifications.
limitintegerOptionalNumber of results per page (1–100, default 20)
cursorstringOptionalPagination cursor from the previous response

GET /api/breeder/notifications — unread only

curl "https://herpify.com/api/breeder/notifications?seen=false" \
  -H "Authorization: Bearer hm_live_your_key_here"

Response

{
  "data": [
    {
      "id": "clx1notif1",
      "type": "INQUIRY_RECEIVED",
      "referenceId": "clx1listing1",
      "referenceType": "Listing",
      "message": "You have a new inquiry on Pastel Ball Python",
      "seen": false,
      "seenAt": null,
      "createdAt": "2026-05-07T11:00:00.000Z"
    }
  ],
  "meta": { "limit": 20, "hasMore": false, "nextCursor": null }
}

Mark all notifications as read

Marks all unseen notifications as seen. Returns the number of notifications updated.

POST /api/breeder/notifications/mark-all-read

curl -X POST https://herpify.com/api/breeder/notifications/mark-all-read \
  -H "Authorization: Bearer hm_live_your_key_here"

Response

{ "data": { "markedRead": 5 } }

Notification types

The `type` field identifies what triggered the notification:

  • `INQUIRY_RECEIVED` — A buyer sent an inquiry on one of your listings
  • `LISTING_FAVOURITE` — A buyer favourited one of your listings
  • `REVIEW_RECEIVED` / `NEW_REVIEW` — A new review was posted on your profile
  • `WAITLIST_JOIN` — A buyer joined a waitlist on one of your pairings
  • `PAIRING_HATCHED` — A pairing you follow has a hatch update
  • `NEW_FOLLOWER` — Someone followed your profile
  • `LISTING_EXPIRING` / `LISTING_EXPIRED` — Your listing is about to expire or has expired
  • `VERIFICATION_APPROVED` / `VERIFICATION_REJECTED` — Your breeder verification status changed
  • `SUBSCRIPTION_DOWNGRADING` — Your subscription will downgrade at the end of the billing period

Was this article helpful?