v2

latestOpenAPI 3.1.0MIT2026-07-26105151330.5 KB
Projects/Brands

Get Project Field Catalog

Returns subscriber field metadata for the project: which fields exist, how often each is populated (fillRate), example values, and whether the field is auto-filled at send time. Powers variable pickers, persona prefill, and template-coverage UIs. Optionally scope the result to a specific segment or tag.

get/v1/projects/{projectId}/field-catalog

Path parameters

projectIdstring required

Project ID (MongoDB ObjectId)

Query parameters

segmentIdstring

Restrict the catalog to subscribers in this segment.

tagstring

Restrict the catalog to subscribers with this tag id.

Response

Field catalog response

successboolean required
errorstring nullable