List invites

Answers the caller's invites, newest first, with how many were sent, how many joined, and how many more they may send now.

GET /v1/marketing/beta/invites

Marketing → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/marketing/beta/invites`
Method	`GET`
Operation	`get_marketing_beta_invites`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Answers the caller's invites, newest first, with how many were sent, how many joined, and how many more they may send now. A reservation that lapsed unsent is not listed: it holds nothing.

Request

GET /v1/marketing/beta/invites takes no parameters and no body — the credential is the whole request.

Response

Status	Body	Meaning
`200`	marketing.BetaInviteList	ok
`default`	problem-details	refused

200 body — 9 fields.

Field	In	Type	Always	Description
`counts`	body	marketing.BetaInviteCounts	—
`counts.joined`	body	integer (int64)	—	Joined counts invites whose invitee signed up with the member's code.
`counts.left`	body	integer (int64)	—	Left is how many more the member may invite now.
`counts.sent`	body	integer (int64)	—	Sent counts invites sent, joined ones included.
`invites`	body	marketing.BetaInviteRow[]	—	Invites are the caller's invites, newest first; a reservation that lapsed unsent is not among them.
`invites[].at`	body	string	—	At is when it last moved, RFC 3339 in UTC.
`invites[].id`	body	string	—	ID is the invite's id.
`invites[].status`	body	string	—	Status is reserved, sent, failed or joined.
`invites[].to`	body	string	—	To is the invited address.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo marketing beta invites get

.ts

.py

.go

.rs

.java

import { Configuration, MarketingApi } from 'hanzoai';

const api = new MarketingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getMarketingBetaInvites();

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = MarketingApi(client).get_marketing_beta_invites()

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

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

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

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

let result = marketing_api::get_marketing_beta_invites(&cfg, Default::default()).await?;

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

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

var result = new MarketingApi(client).getMarketingBetaInvites();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl https://api.hanzo.ai/v1/marketing/beta/invites \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches marketing through the marketing tool, which names its 82 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": "list_marketing_audiences"
         }
       }
     }'

Marketing API · All Hanzo APIs · Interactive reference

Was this page useful?

Broken link or missing step? Drop it in #docs on Discord or open a PR.

PreviousList audiences NextList beta