Get Custom Field

Tool name: get-custom-field

Reads one custom-field definition: type, placeholder, API key, metadata, copy target and whether values are per subscription. Contact values are read with get-contact.

Input schema

customFieldIdstring, [ 1 .. 100 ] characters^[A-Za-z0-9_]+$required

Field ID: a number for the account's own field, a name such as "FirstName" for a global one

accountIdnull or integer, >= 1

User ID of the account; omit for the account the access token works in

Default:null

Input example

{
  "customFieldId": "string",
  "accountId": null
}

Output schema

accountIdintegerrequired

idstringrequired

namestringrequired

typestringrequired

isGlobalbooleanrequired

multiValuebooleanrequired

placeholderstringrequired

apiFieldIdstringrequired

categorystringrequired

descriptionstringrequired

notesstringrequired

metaLabelsArray of stringsrequired

copyToFieldIdstringrequired

requestNamestringrequired

editUrlstringrequired

Output example

{
  "accountId": 0,
  "id": "string",
  "name": "string",
  "type": "string",
  "isGlobal": true,
  "multiValue": true,
  "placeholder": "string",
  "apiFieldId": "string",
  "category": "string",
  "description": "string",
  "notes": "string",
  "metaLabels": [
    "string"
  ],
  "copyToFieldId": "string",
  "requestName": "string",
  "editUrl": "string"
}