List fields

Returns the custom fields the org defined for its subscribers.

GET /v1/marketing/fields

Marketing → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/marketing/fields`
Method	`GET`
Operation	`get_marketing_fields`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns the custom fields the org defined for its subscribers.

Request

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

Response

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

200 body — 5 fields.

Field	In	Type	Always	Description
`data`	body	marketing.Field[]	—	Data is every field, in the order they were defined.
`data[].choices`	body	string[]	—	Choices are the values a choice field may take; at most 100.
`data[].key`	body	string	—	Key names the field in a subscriber's fields and in a filter: a lower-case letter, then letters, digits and underscores, at most 40.
`data[].label`	body	string	—	Label is how the field is shown; at most 100 characters.
`data[].type`	body	string	—	Type is text, number, date (YYYY-MM-DD), boolean (true or false) or choice.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo marketing fields 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.getMarketingFields();

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_fields()

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

resp, _, err := client.MarketingAPI.GetMarketingFields(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_fields(&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).getMarketingFields();

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/fields \
  -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 click NextGet imports