Hanzo
OpenapiCommerce

Fetch one subscriber

A subscriber is a mailing-list member — name, email, the form id that captured them, unsubscribed state and date, client details, tags and metadata.

GET /v1/commerce/subscriber/{subscriberid}

Addresshttps://api.hanzo.ai/v1/commerce/subscriber/{subscriberid}
MethodGET
Operationget_commerce_subscriber_by_subscriberid
AuthAuthorization: Bearer $HANZO_API_KEY

A subscriber is a mailing-list member — name, email, the form id that captured them, unsubscribed state and date, client details, tags and metadata. Writing one FIRES A WEBHOOK: subscriber.created on create and subscriber.updated on replace or patch, emitted BEFORE the write is known to have succeeded and carrying the row as sent, so the payload holds the raw email rather than the normalized one that gets stored. Reads the addressed row from the caller org's own namespaced store. An id that is not there is 404 — and another tenant's id is not there by construction, so it reads exactly like a typo instead of confirming the row exists somewhere else. Any valid access token reaches it. The token must also carry Admin or ReadSubscriber.

Request

1 field.

FieldInTypeRequiredDescription
subscriberidpathstringyes

Response

The document declares no response body for this operation. It answers 200 on success and the platform error shape on failure — see Errors.

Examples

hanzo commerce subscriber get <subscriberid>

Commerce API · All Hanzo APIs · Interactive reference

How is this guide?

On this page