Get 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}

Commerce → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/commerce/subscriber/{subscriberid}`
Method	`GET`
Operation	`get_commerce_subscriber_by_subscriberid`
Auth	`Authorization: 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.

Field	In	Type	Required	Description
`subscriberid`	path	string	yes

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

CLI

SDK

HTTP

MCP

hanzo commerce subscriber get <subscriberid>

.ts

.py

.go

.rs

.java

import { Configuration, CommerceApi } from 'hanzoai';

const api = new CommerceApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getCommerceSubscriberBySubscriberid({ subscriberid: 'subscriberid' });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import CommerceApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = CommerceApi(client).get_commerce_subscriber_by_subscriberid(subscriberid='subscriberid')

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.CommerceAPI.GetCommerceSubscriberBySubscriberid(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, commerce_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = commerce_api::get_commerce_subscriber_by_subscriberid(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.CommerceApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new CommerceApi(client).getCommerceSubscriberBySubscriberid();

curl https://api.hanzo.ai/v1/commerce/subscriber/<subscriberid> \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches commerce through the commerce tool, which names its 5 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "get_commerce_health"
         }
       }
     }'

Commerce API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList submission NextList subscriber