Wired Plus API Documentation

API v1 Guide

Account

Automation

Contacts

Dynamic Rows

Lists

Campaigns

Transactional Emails

Lead Score

Products

Carts

Orders

Custom Fields

GET GetCustomFields

Retrieves record custom fields in the system.

Input and output parameters

The input and output parameters for this method are:

*denotes required field.

Input Parameter Name Type/Info
name Filter by the field name.
record_name Filter by record_name, contact | product | cart | order.
select Number of results to return, max of 500.
skip The number of custom fields to skip.
sort Sort results by: name_asc | name_desc | create_date_asc | create_date_desc | update_date_asc | update_date_desc.
Outputs:
  • id, of the custom field
  • record_name, record custom field is assign to, contact | product | cart | order
  • name, field name
  • description, details about the field
  • create_date, date record was created)
  • created_by, who created the record
  • update_date, date record was updated)
  • updated_by, who updated the record
  • dynamic_name, used to build up merge tags
  • type, data expected to be stored, 1=text, 2=number, 3=date
  • data_type_name, text representation of type
  • default_value, when null, this value will be used.
  • visibility, 0=private, 1=public
  • searchable, 0=no, 1=yes
  • required, will enforce this field is populated, 0=no, 1=yes
  • status, 0=disabled, 1=enabled

Examples

Curl

PHP

jQuery

Result Format JSON