{"id":10946,"date":"2024-06-25T11:30:23","date_gmt":"2024-06-25T10:30:23","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=10946"},"modified":"2024-06-25T12:20:53","modified_gmt":"2024-06-25T11:20:53","slug":"get-custom-fields-list","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/get-custom-fields-list\/","title":{"rendered":"Get custom fields list"},"content":{"rendered":"\n

Fields collection allows retrieving information about all defined subscriber custom fields (custom subscriber properties) in business unit.<\/p>\n\n\n\n

Request data format<\/strong><\/h3>\n\n\n\n

Request URL parameters:<\/p>\n\n\n\n

Parameter<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
apiKey<\/td>string<\/td>Your API key, required for authentication. Required.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Examples:<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
https:\/\/api.esv2.com\/v2\/Api\/Fields?apiKey=test_api_key1<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Response<\/strong><\/p>\n\n\n\n
Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
Fields<\/td>array[complex]<\/td>Array of Field elements.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Field element children:<\/p>\n\n\n\n
Element\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>
Id<\/td>int<\/td>Custom field identifier.<\/td><\/tr>
Name<\/td>string<\/td>Custom field name.<\/td><\/tr>
FriendlyName<\/td>string<\/td>Custom field “friendly” name for display purposes.<\/td><\/tr>
Type<\/td>string<\/td>Custom field type. One of: Text, Number, Money, Date, Datetime, SingleSelect, Boolean, Url.<\/td><\/tr>
DefaultValue<\/td>mixed<\/td>Custom field default value. Content depends on field type. Optional.<\/td><\/tr>
Description<\/td>string<\/td>Text description of custom field. Optional.<\/td><\/tr>
Visible<\/td>boolean<\/td>True, if custom field is visible to subscribers in e.g. Preference Center.<\/td><\/tr>
Required<\/td>boolean<\/td>True, if custom field is required when subscribing to a list.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Examples<\/strong><\/h3>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
GET https:\/\/api.esv2.com\/v2\/Api\/Fields?apiKey=test_api_key1 HTTP\/1.1<\/span><\/span>\nAccept-Encoding: gzip,deflate<\/span><\/span>\nHost: api.esv2.com<\/span><\/span>\nConnection: Keep-Alive<\/span><\/span>\nUser-Agent: Apache-HttpClient\/4.1.1 (java 1.5)<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
OK response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 200 OK<\/span><\/span>\nCache-Control: private<\/span><\/span>\nContent-Type: text\/xml; charset=utf-8<\/span><\/span>\nServer: Microsoft-IIS\/7.5<\/span><\/span>\nX-AspNetMvc-Version: 5.2<\/span><\/span>\nX-AspNet-Version: 4.0.30319<\/span><\/span>\nSet-Cookie: TEMP_DATA=c0d53e6c-d043-474f-b899-c7bc080f637d; path=\/<\/span><\/span>\nX-Powered-By: ASP.NET<\/span><\/span>\nDate: Mon, 02 Feb 2015 17:06:10 GMT<\/span><\/span>\nContent-Length: 1877<\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span>><\/span><\/span>\n  <\/span><<\/span>Data<\/span>><\/span><\/span>\n    <\/span><<\/span>Fields<\/span>><\/span><\/span>\n      <\/span><<\/span>Field<\/span>><\/span><\/span>\n        <\/span><<\/span>Id<\/span>><\/span>1<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n        <\/span><<\/span>Name<\/span>><\/span>booltest<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n        <\/span><<\/span>FriendlyName<\/span>><\/span>Test Boolean Field<\/span><\/<\/span>FriendlyName<\/span>><\/span><\/span>\n        <\/span><<\/span>Type<\/span>><\/span>Boolean<\/span><\/<\/span>Type<\/span>><\/span><\/span>\n        <\/span><<\/span>DefaultValue<\/span>><\/span>1<\/span><\/<\/span>DefaultValue<\/span>><\/span><\/span>\n        <\/span><<\/span>Description<\/span>><\/span>This is a test boolean field with default value.<\/span><\/<\/span>Description<\/span>><\/span><\/span>\n        <\/span><<\/span>Visible<\/span>><\/span>True<\/span><\/<\/span>Visible<\/span>><\/span><\/span>\n        <\/span><<\/span>Required<\/span>><\/span>False<\/span><\/<\/span>Required<\/span>><\/span><\/span>\n      <\/span><\/<\/span>Field<\/span>><\/span><\/span>\n      <\/span><<\/span>Field<\/span>><\/span><\/span>\n        <\/span><<\/span>Id<\/span>><\/span>2<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n        <\/span><<\/span>Name<\/span>><\/span>reqtext<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n        <\/span><<\/span>FriendlyName<\/span>><\/span>Required Text Field<\/span><\/<\/span>FriendlyName<\/span>><\/span><\/span>\n        <\/span><<\/span>Type<\/span>><\/span>Text<\/span><\/<\/span>Type<\/span>><\/span><\/span>\n        <\/span><<\/span>DefaultValue<\/span> \/><\/span><\/span>\n        <\/span><<\/span>Description<\/span>><\/span>This is a test text value which is required.<\/span><\/<\/span>Description<\/span>><\/span><\/span>\n        <\/span><<\/span>Visible<\/span>><\/span>False<\/span><\/<\/span>Visible<\/span>><\/span><\/span>\n        <\/span><<\/span>Required<\/span>><\/span>True<\/span><\/<\/span>Required<\/span>><\/span><\/span>\n      <\/span><\/<\/span>Field<\/span>><\/span><\/span>\n      <\/span><<\/span>Field<\/span>><\/span><\/span>\n        <\/span><<\/span>Id<\/span>><\/span>3<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n        <\/span><<\/span>Name<\/span>><\/span>numtest<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n        <\/span><<\/span>FriendlyName<\/span>><\/span>Test Number Field<\/span><\/<\/span>FriendlyName<\/span>><\/span><\/span>\n        <\/span><<\/span>Type<\/span>><\/span>Number<\/span><\/<\/span>Type<\/span>><\/span><\/span>\n        <\/span><<\/span>Description<\/span>><\/span>This is a test number field.<\/span><\/<\/span>Description<\/span>><\/span><\/span>\n        <\/span><<\/span>Visible<\/span>><\/span>False<\/span><\/<\/span>Visible<\/span>><\/span><\/span>\n        <\/span><<\/span>Required<\/span>><\/span>False<\/span><\/<\/span>Required<\/span>><\/span><\/span>\n      <\/span><\/<\/span>Field<\/span>><\/span><\/span>\n    <\/span><\/<\/span>Fields<\/span>><\/span><\/span>\n  <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":13,"featured_media":0,"parent":3551,"menu_order":0,"template":"","format":"standard","emp-category":[],"class_list":["post-10946","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/10946","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es"}],"about":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/types\/es"}],"author":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/users\/13"}],"version-history":[{"count":1,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/10946\/revisions"}],"predecessor-version":[{"id":10947,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/10946\/revisions\/10947"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3551"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=10946"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=10946"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}