Search Custom Fields

Tool name: search-custom-fields

Lists the custom field definitions of a KlickTipp account with ID, name, data type, the placeholder that renders the value of the receiving contact in newsletter content, and the group the account sorted the field into. Fields the account created itself come first, newest first, followed by the global fields every KlickTipp account has, such as first name or city; the global ones are marked with isGlobal and cannot be changed or deleted. Can be narrowed by a text the name has to contain, by data type, and to the fields the write tools may touch. This lists definitions -- what a contact has stored in a field is read through the contact tools.

Input schema

querynull or string, <= 250 characters

Text the name of a field has to contain; omit to list them all

Default:null

typesArray of strings or null, unique

Only fields of these data types, for example ["field-date", "field-datetime"]; omit for every type

Default:null

Items Enum:"field-single""field-paragraph""field-email""field-number""field-url""field-date""field-time""field-datetime""field-html""field-decimal"

onlyWritablenull or boolean

Only the account's own fields, the ones the write tools may touch; omit to include the global fields

Default:null

limitnull or integer, [ 1 .. 200 ]

How many fields to return at most, 1 to 200, 50 by default

Default:null

accountIdnull or integer, >= 1

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

Default:null

Input example

{
  "query": null,
  "types": null,
  "onlyWritable": null,
  "limit": null,
  "accountId": null
}

Output schema

accountIdintegerrequired

countintegerrequired

totalCountintegerrequired

hasMorebooleanrequired

customFieldsArray of objectsrequired

Output example

{
  "accountId": 0,
  "count": 0,
  "totalCount": 0,
  "hasMore": true,
  "customFields": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "isGlobal": true,
      "multiValue": true,
      "placeholder": "string",
      "apiFieldId": "string",
      "category": "string",
      "editUrl": "string"
    }
  ]
}