Remembrance API
Connect your own platform to Remembrance: retrieve paw and nose prints, look up folders and memorials by Pet ID, and pull leads from your website widgets.
This page is for whoever looks after your website or software. If that is not you, send them this link. Prefer to work by chat? Connect your AI assistant instead.
Get an API key
API keys are created in the Remembrance portal under Integrations. Owners and Admins of a provider account can create a key, give it a label, set its allowed origins and revoke it. Keep your key private: anyone with it can read your data.
Authentication
Send your API key in the Authorization header of every request, as a Bearer token:
Authorization: Bearer rs_live_your_key_hereBase URL
https://app.remembrancepets.com/api/v1Endpoints
| Endpoint | What it returns |
|---|---|
| GET /leads | List the leads captured by your Quality of Life and Pre-planner widgets, newest first. See the field reference below. |
| GET /prints | List final, exported prints (the default). Supports the filters below. |
| GET /prints/{id} | One print with its download links. Returns any print, whatever its type. |
| GET /folders | List all folders. |
| GET /folders/{id} | One folder. {id} is the folder UUID or the folder name (the Pet ID). Includes memorials: the stars, memorial trees and ocean memorials with the same Pet ID, each with registration_number, kind (star, tree or ocean), pet_name and memorial_url. |
| GET /folders/{id}/prints | Final prints in one folder. Supports the same filters as /prints. |
Leads
GET /leads returns the leads captured by your embeddable Quality of Life and Pre-planner widgets, newest first. Query parameters:
| Parameter | Meaning |
|---|---|
| tool_type | qol or preplanner. |
| status | new, contacted or converted. |
| since | An ISO timestamp. Only leads created after it, for syncing just what is new. |
| limit | 100 by default, 500 at most. |
| offset | How many to skip, for the next page. |
Example
curl -H "Authorization: Bearer YOUR_KEY" \
"https://app.remembrancepets.com/api/v1/leads?tool_type=qol&since=2026-06-01T00:00:00Z"
# Returns:
# { "data": [ { ...the fields below... } ],
# "meta": { "count", "limit", "offset", "has_more", "next_offset" } }Lead field reference
Each lead in GET /leads, and the data object in every lead webhook, has these fields.
| Field | Type | Description |
|---|---|---|
| id | uuid | Unique lead id. |
| tool_type | qol | preplanner | Which widget captured the lead. |
| first_name | string | Lead's first name. |
| last_name | string | Lead's last name. |
| string | Contact email. | |
| phone | string | null | Phone, if provided. |
| string | null | WhatsApp number, if provided. | |
| pet_name | string | null | Pet's name. |
| pet_species | string | null | dog or cat, if provided. |
| pet_age | int | null | Age in years. |
| pet_weight | number | null | Weight in lbs. |
| pet_breed | string | null | Breed, if provided. |
| score | int | Quality of Life score, 0 to 20 (lower is better). |
| status | new | contacted | converted | Where the lead is in your follow-up. |
| activated | bool | True once the lead activated an app account. |
| notes | string | null | The owner's note on the lead. |
| entry_data | object | Full assessment answers. |
| created_at | string (ISO) | When the lead was captured. |
Filters for /prints and /folders/{id}/prints
| Parameter | Meaning |
|---|---|
| folder={id} | Only one folder. Accepts the folder UUID or name (Pet ID). Names match ignoring surrounding spaces and letter case. An unknown folder returns 404; a name matching more than one folder returns 409. /prints only. |
| type={value} | One of final, original, paw, nose, life_print, combo. Anything else returns 400. type=nose is the same as paw, since nose scans are stored as paw prints. |
| type=original | Only originals (raw uploads with no exported print). |
| include=originals | Return finals and originals together. |
| limit, offset | Pagination. limit is 20 by default, 100 at most. Values out of range are clamped, not rejected. |
Rate limits
100 requests per minute per API key. Going over returns status 429 with a Retry-After header.
Calling from a browser
If you call the API from a web page, such as your customer portal, add your domain to the Allowed Origins for your API key in the portal. Without it, browsers block the request.
Webhooks
Webhooks send each new lead to your CRM the moment it is captured, so you do not have to keep asking /leads. Set them up in the portal under Integrations, on the Webhooks tab. You can add an endpoint for all widgets or just one, send a test event, rotate the signing secret, and see every delivery.
The lead.created event
When a lead is captured, we POST this body to each active endpoint. The data object has the same fields as the lead field reference above.
POST <your endpoint>
X-Remembrance-Signature: t=1718000000,v1=<hex hmac>
{
"event": "lead.created",
"created_at": "2026-06-07T00:00:00Z",
"webhook_id": "...",
"data": { ...same fields as GET /leads... }
}Checking the signature
Every request carries X-Remembrance-Signature: t=<timestamp>,v1=<hex>. To check it:
- Read the raw request body. Do not re-serialize it.
- Read t and v1 from the header.
- Compute HMAC-SHA256(signing_secret, "<t>.<raw_body>") as hex.
- Compare it to v1 with a constant-time comparison.
- Reject the request if t is older than your tolerance, for example 5 minutes, to block replays.
Retries
Reply with a 2xx status quickly to acknowledge. Anything else, or a timeout, is retried with exponential backoff, up to 6 attempts. After that the delivery is marked exhausted. Every attempt shows in the delivery log in the portal, where you can resend it.