Skip to content

Get Data Field

Request

Gets a data field by its unprefixed ID. For example, collection key field12345 is retrieved with /field/12345; fieldFirstName with /field/FirstName.

Without detail=true, the response contains id and name; detail=true also adds type, multidimensional, ai_description, category, and meta_labels. All detailed properties are always present, including empty strings and an empty label array when no metadata is configured.

The type vocabulary is extensible; clients should handle unfamiliar tokens. Current types (JSON value types and input examples for writing contact field values):

TypeMeaningJSON value / input formatExample
field-singleSingle-line textString"Alex"
field-paragraphMultiline textString"Line 1\nLine 2"
field-emailEmail addressString containing a valid email address"alex@example.com"
field-numberWhole numberJSON integer100
field-urlURLString with absolute http:// or https:// URL"https://example.com"
field-dateCalendar dateJSON integer, Unix timestamp in seconds755222400
field-timeTime of dayJSON integer, seconds since midnight (0–86399)52200
field-datetimeDate and timeJSON integer, Unix timestamp in seconds representing a UTC instant1715603400
field-htmlHTML contentString containing HTML"<p>Hello</p>"
field-decimalDecimal numberJSON integer scaled by 100 (1999 displays as 19.99)1999
field-unknownLegacy or unsupported field type (e.g. dropdown, checkbox or internal array)No reliable input format; do not derive validation behavior from this token—

For date and date-time values use seconds, not milliseconds or formatted date strings. Convert local date-times to a UTC instant before sending.

Path
fieldidstringrequired

Unprefixed data field ID (for field12345, pass 12345)

Example:12345
Query
detailboolean

Include the field type, dimensionality, AI description, category name, and meta-label names.

Default:false
curl -i -X GET \
  https://api.klicktipp.com/field/12345

Responses

Success Response.

Bodyapplication/json
One of:

Compact response (default or detail=false).

idinteger or stringrequired
One of:

Unprefixed data field ID; numeric for account fields, string for global fields

integer
namestringrequired

Name of the data field

Response
{ "id": 12345, "name": "Webinar date" }