Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Retrieve a contact

GET /contacts/{address}

The address, URL-encoded: GET /contacts/alice%40example.com.

{ "id": "8412", "email": "alice@example.com", "first_name": "Alice", "last_name": "Ng", "properties": { "plan": "pro", "seats": 9 }, "unsubscribed": false, "unsubscribe_reason": "", "created_at": 1735689600, "topics": { "product-updates": true, "weekly-digest": false } }

404 not_found when that address is not a contact of yours.

What unsubscribed and topics each mean

unsubscribed is the global opt-out: no broadcast reaches them, whatever its topic. topics is the narrower answer — per topic, with the topic’s own default applied where they have never said.

unsubscribe_reason is worth reading. complaint is a spam report, which is sending reputation being spent rather than a preference somebody changed; it is also the one state you cannot undo through /subscribe.

Transactional mail is unaffected by either. Consent here governs broadcasts, and a receipt is mail they asked for.