Node.js SDK
import Migma from 'migma';
const migma = new Migma('YOUR_API_KEY');
const { data, error } = await migma.projects.fieldCatalog('PROJECT_ID');
// Scope to a segment or tag:
// await migma.projects.fieldCatalog('PROJECT_ID', { segmentId: 'SEGMENT_ID' });
// await migma.projects.fieldCatalog('PROJECT_ID', { tag: 'TAG_ID' });curl --request GET \
--url https://api.migma.ai/v1/projects/{projectId}/field-catalog \
--header 'Authorization: <api-key>'import requests
url = "https://api.migma.ai/v1/projects/{projectId}/field-catalog"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.migma.ai/v1/projects/{projectId}/field-catalog",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.migma.ai/v1/projects/{projectId}/field-catalog"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.migma.ai/v1/projects/{projectId}/field-catalog")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.migma.ai/v1/projects/{projectId}/field-catalog")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"entries": [
{
"key": "<string>",
"label": "<string>",
"type": "string",
"fillRate": 0.5,
"sample": [
"<string>"
],
"auto": true
}
],
"totalSubscribers": 123,
"computedAt": "2023-11-07T05:31:56Z"
},
"error": "<string>"
}{
"success": false,
"error": "<string>",
"code": "<string>",
"data": {}
}{
"success": false,
"error": "<string>",
"code": "<string>",
"data": {}
}{
"success": false,
"error": "<string>",
"code": "<string>",
"data": {}
}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
Node.js SDK
import Migma from 'migma';
const migma = new Migma('YOUR_API_KEY');
const { data, error } = await migma.projects.fieldCatalog('PROJECT_ID');
// Scope to a segment or tag:
// await migma.projects.fieldCatalog('PROJECT_ID', { segmentId: 'SEGMENT_ID' });
// await migma.projects.fieldCatalog('PROJECT_ID', { tag: 'TAG_ID' });curl --request GET \
--url https://api.migma.ai/v1/projects/{projectId}/field-catalog \
--header 'Authorization: <api-key>'import requests
url = "https://api.migma.ai/v1/projects/{projectId}/field-catalog"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.migma.ai/v1/projects/{projectId}/field-catalog",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.migma.ai/v1/projects/{projectId}/field-catalog"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.migma.ai/v1/projects/{projectId}/field-catalog")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.migma.ai/v1/projects/{projectId}/field-catalog")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"entries": [
{
"key": "<string>",
"label": "<string>",
"type": "string",
"fillRate": 0.5,
"sample": [
"<string>"
],
"auto": true
}
],
"totalSubscribers": 123,
"computedAt": "2023-11-07T05:31:56Z"
},
"error": "<string>"
}{
"success": false,
"error": "<string>",
"code": "<string>",
"data": {}
}{
"success": false,
"error": "<string>",
"code": "<string>",
"data": {}
}{
"success": false,
"error": "<string>",
"code": "<string>",
"data": {}
}Authorizations
API key authentication. Use 'Authorization: Bearer YOUR_API_KEY' where YOUR_API_KEY is obtained from the Migma dashboard under Settings → Developers → API Keys.
Path Parameters
Project ID (MongoDB ObjectId)
Pattern:
^[0-9a-fA-F]{24}$Query Parameters
Restrict the catalog to subscribers in this segment.
Pattern:
^[0-9a-fA-F]{24}$Restrict the catalog to subscribers with this tag id.
Pattern:
^[0-9a-fA-F]{24}$Last modified on September 1, 2026
Was this page helpful?