For more information on using API

GET https://webapi.mymarketing.co.il/api/account/contactFields?FieldsType={FieldsType}

Get the account contact fields filtered by fields' type

Request Information

URI Parameters

Name

Description

Type

Additional information

fieldsType

UserFieldObjectTypes

Body Parameters

None.

Response Information

Resource Description

Collection of ApiUserField

Name

Description

Type

Additional information

id

Column id

integer
external_id

The external id for API integrations with other systems

integer
field_display_name

The field name that the customer created

string
field_display_order

Order of display in the web application

integer
field_name

Field original name

string
field_object_type

Column name

UserFieldObjectTypes
field_source_column

Column name

string
field_type

Type of column

integer
field_value

Value of the column

string
is_active

If the field is active the value is 1. If the field is not active the value is 0.

boolean

Response Formats

application/json, text/json

Sample: 
[
  {
    "id": 1,
    "external_id": 2,
    "field_display_name": "sample string 3",
    "field_display_order": 4,
    "field_name": "sample string 5",
    "field_object_type": "Text",
    "field_source_column": "sample string 6",
    "field_type": 7,
    "field_value": "sample string 8",
    "is_active": true
  },
  {
    "id": 1,
    "external_id": 2,
    "field_display_name": "sample string 3",
    "field_display_order": 4,
    "field_name": "sample string 5",
    "field_object_type": "Text",
    "field_source_column": "sample string 6",
    "field_type": 7,
    "field_value": "sample string 8",
    "is_active": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfApiUserField xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <ApiUserField>
    <external_id>2</external_id>
    <field_display_name>sample string 3</field_display_name>
    <field_display_order>4</field_display_order>
    <field_name>sample string 5</field_name>
    <field_object_type>Text</field_object_type>
    <field_source_column>sample string 6</field_source_column>
    <field_type>7</field_type>
    <field_value>sample string 8</field_value>
    <id>1</id>
    <is_active>true</is_active>
  </ApiUserField>
  <ApiUserField>
    <external_id>2</external_id>
    <field_display_name>sample string 3</field_display_name>
    <field_display_order>4</field_display_order>
    <field_name>sample string 5</field_name>
    <field_object_type>Text</field_object_type>
    <field_source_column>sample string 6</field_source_column>
    <field_type>7</field_type>
    <field_value>sample string 8</field_value>
    <id>1</id>
    <is_active>true</is_active>
  </ApiUserField>
</ArrayOfApiUserField>