For more information on using API
GET https://webapi.mymarketing.co.il/api/contacts?CustomerStates={CustomerStates}&SearchTerm={SearchTerm}&FromDate={FromDate}&ToDate={ToDate}&Page={Page}&Limit={Limit}
Get account's contacts list. You can get the list filtered by customer status (active, unsubscribed, bounced. etc.,) by the state change date (from/to date, the defualt is three months back)
Request Information
URI Parameters
Name
Description
Type
Additional information
customer_states
Choose the states (status) of the contact you want to get. It is enough that one of the statuses (email or sms) will be in the chosen status.
search_term
Search by email/sms. please note: you cannot search for emails that contain the plus sign.
string
from_date
The start date the campaign was last updated
date
to_date
The end date the campaign was last updated
date
page
Get a specific page (number of pages is limited)
integer
Range: inclusive between 1 and 2147483647
limit
Limit the number of items you get in the results. (Removing the "limit" will, by default, display only 20 records)
integer
Range: inclusive between 1 and 100
Body Parameters
None.
Response Information
Resource Description
Name
Description
Type
Additional information
id
Contact field
integer
is_optined
Contact field
boolean
email
Required if SMS is null. please note: mendatory in the endpoint "Create a new contact" and in "Send an email operational message to individual contacts"
string
sms
Required if email is null.
string
first_name
Contact field
string
last_name
Contact field
string
anniversary
Contact field
date
birthday
Contact field
date
city
Contact field
string
fax
Contact field
string
phone1
Contact field
string
phone2
Contact field
string
street
Contact field
string
zip_code
Contact field
string
ext1
Contact field
string
ext2
Contact field
string
ext3
Contact field
string
ext4
Contact field
string
ext5
Contact field
string
ext6
Contact field
string
ext7
Contact field
string
ext8
Contact field
string
ext9
Contact field
string
ext10
Contact field
string
ext11
Contact field
string
ext12
Contact field
string
ext13
Contact field
string
ext14
Contact field
string
ext15
Contact field
string
ext16
Contact field
string
ext17
Contact field
string
ext18
Contact field
string
ext19
Contact field
string
ext20
Contact field
string
ext21
Contact field
string
ext22
Contact field
string
ext23
Contact field
string
ext24
Contact field
string
ext25
Contact field
string
date1
Contact field
date
date2
Contact field
date
date3
Contact field
date
date4
Contact field
date
date5
Contact field
date
num1
Contact field
integer
num2
Contact field
integer
num3
Contact field
integer
num4
Contact field
integer
num5
Contact field
integer
is_deleted
If true - contact will be deleted. If false - contact will be restored if deleted (their status will be the last status they were on ActiveTrail).
boolean
Response Formats
application/json, text/json
Sample:
[
{
"id": 1,
"state": "Unsubscribed",
"is_optined": true,
"email": "sample string 6",
"sms": "sample string 7",
"first_name": "sample string 8",
"last_name": "sample string 9",
"anniversary": "2016-12-24T14:12:12",
"birthday": "2016-12-24T14:12:12",
"city": "sample string 10",
"fax": "sample string 11",
"phone1": "sample string 12",
"phone2": "sample string 13",
"street": "sample string 14",
"zip_code": "sample string 15",
"ext1": "sample string 16",
"ext2": "sample string 17",
"ext3": "sample string 18",
"ext4": "sample string 19",
"ext5": "sample string 20",
"ext6": "sample string 21",
"ext7": "sample string 22",
"ext8": "sample string 23",
"ext9": "sample string 24",
"ext10": "sample string 25",
"ext11": "sample string 26",
"ext12": "sample string 27",
"ext13": "sample string 28",
"ext14": "sample string 29",
"ext15": "sample string 30",
"ext16": "sample string 31",
"ext17": "sample string 32",
"ext18": "sample string 33",
"ext19": "sample string 34",
"ext20": "sample string 35",
"ext21": "sample string 36",
"ext22": "sample string 37",
"ext23": "sample string 38",
"ext24": "sample string 39",
"ext25": "sample string 40",
"date1": "2016-12-24T14:12:12",
"date2": "2016-12-24T14:12:12",
"date3": "2016-12-24T14:12:12",
"date4": "2016-12-24T14:12:12",
"date5": "2016-12-24T14:12:12",
"num1": 1,
"num2": 1,
"num3": 1,
"num4": 1,
"num5": 1,
"is_deleted": true
},
{
"id": 1,
"state": "Unsubscribed",
"is_optined": true,
"email": "sample string 6",
"sms": "sample string 7",
"first_name": "sample string 8",
"last_name": "sample string 9",
"anniversary": "2016-12-24T14:12:12",
"birthday": "2016-12-24T14:12:12",
"city": "sample string 10",
"fax": "sample string 11",
"phone1": "sample string 12",
"phone2": "sample string 13",
"street": "sample string 14",
"zip_code": "sample string 15",
"ext1": "sample string 16",
"ext2": "sample string 17",
"ext3": "sample string 18",
"ext4": "sample string 19",
"ext5": "sample string 20",
"ext6": "sample string 21",
"ext7": "sample string 22",
"ext8": "sample string 23",
"ext9": "sample string 24",
"ext10": "sample string 25",
"ext11": "sample string 26",
"ext12": "sample string 27",
"ext13": "sample string 28",
"ext14": "sample string 29",
"ext15": "sample string 30",
"ext16": "sample string 31",
"ext17": "sample string 32",
"ext18": "sample string 33",
"ext19": "sample string 34",
"ext20": "sample string 35",
"ext21": "sample string 36",
"ext22": "sample string 37",
"ext23": "sample string 38",
"ext24": "sample string 39",
"ext25": "sample string 40",
"date1": "2016-12-24T14:12:12",
"date2": "2016-12-24T14:12:12",
"date3": "2016-12-24T14:12:12",
"date4": "2016-12-24T14:12:12",
"date5": "2016-12-24T14:12:12",
"num1": 1,
"num2": 1,
"num3": 1,
"num4": 1,
"num5": 1,
"is_deleted": true
}
]
application/xml, text/xml
Sample:
<ArrayOfContactContainerItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
<ContactContainerItem>
<anniversary>2016-12-24T14:12:12</anniversary>
<birthday>2016-12-24T14:12:12</birthday>
<city>sample string 10</city>
<date1>2016-12-24T14:12:12</date1>
<date2>2016-12-24T14:12:12</date2>
<date3>2016-12-24T14:12:12</date3>
<date4>2016-12-24T14:12:12</date4>
<date5>2016-12-24T14:12:12</date5>
<dontSentToKafka>true</dontSentToKafka>
<email>sample string 6</email>
<eventGuid>2e340650-4fea-415c-b811-05c813cb182c</eventGuid>
<ext1>sample string 16</ext1>
<ext10>sample string 25</ext10>
<ext11>sample string 26</ext11>
<ext12>sample string 27</ext12>
<ext13>sample string 28</ext13>
<ext14>sample string 29</ext14>
<ext15>sample string 30</ext15>
<ext16>sample string 31</ext16>
<ext17>sample string 32</ext17>
<ext18>sample string 33</ext18>
<ext19>sample string 34</ext19>
<ext2>sample string 17</ext2>
<ext20>sample string 35</ext20>
<ext21>sample string 36</ext21>
<ext22>sample string 37</ext22>
<ext23>sample string 38</ext23>
<ext24>sample string 39</ext24>
<ext25>sample string 40</ext25>
<ext3>sample string 18</ext3>
<ext4>sample string 19</ext4>
<ext5>sample string 20</ext5>
<ext6>sample string 21</ext6>
<ext7>sample string 22</ext7>
<ext8>sample string 23</ext8>
<ext9>sample string 24</ext9>
<externalId>sample string 4</externalId>
<externalName>sample string 5</externalName>
<externalSFId>sample string 2</externalSFId>
<externalSFName>sample string 3</externalSFName>
<fax>sample string 11</fax>
<first_name>sample string 8</first_name>
<is_deleted>true</is_deleted>
<is_do_not_mail>true</is_do_not_mail>
<last_name>sample string 9</last_name>
<num1>1</num1>
<num2>1</num2>
<num3>1</num3>
<num4>1</num4>
<num5>1</num5>
<phone1>sample string 12</phone1>
<phone2>sample string 13</phone2>
<sms>sample string 7</sms>
<street>sample string 14</street>
<zip_code>sample string 15</zip_code>
</ContactContainerItem>
<ContactContainerItem>
<anniversary>2016-12-24T14:12:12</anniversary>
<birthday>2016-12-24T14:12:12</birthday>
<city>sample string 10</city>
<date1>2016-12-24T14:12:12</date1>
<date2>2016-12-24T14:12:12</date2>
<date3>2016-12-24T14:12:12</date3>
<date4>2016-12-24T14:12:12</date4>
<date5>2016-12-24T14:12:12</date5>
<dontSentToKafka>true</dontSentToKafka>
<email>sample string 6</email>
<eventGuid>2e340650-4fea-415c-b811-05c813cb182c</eventGuid>
<ext1>sample string 16</ext1>
<ext10>sample string 25</ext10>
<ext11>sample string 26</ext11>
<ext12>sample string 27</ext12>
<ext13>sample string 28</ext13>
<ext14>sample string 29</ext14>
<ext15>sample string 30</ext15>
<ext16>sample string 31</ext16>
<ext17>sample string 32</ext17>
<ext18>sample string 33</ext18>
<ext19>sample string 34</ext19>
<ext2>sample string 17</ext2>
<ext20>sample string 35</ext20>
<ext21>sample string 36</ext21>
<ext22>sample string 37</ext22>
<ext23>sample string 38</ext23>
<ext24>sample string 39</ext24>
<ext25>sample string 40</ext25>
<ext3>sample string 18</ext3>
<ext4>sample string 19</ext4>
<ext5>sample string 20</ext5>
<ext6>sample string 21</ext6>
<ext7>sample string 22</ext7>
<ext8>sample string 23</ext8>
<ext9>sample string 24</ext9>
<externalId>sample string 4</externalId>
<externalName>sample string 5</externalName>
<externalSFId>sample string 2</externalSFId>
<externalSFName>sample string 3</externalSFName>
<fax>sample string 11</fax>
<first_name>sample string 8</first_name>
<is_deleted>true</is_deleted>
<is_do_not_mail>true</is_do_not_mail>
<last_name>sample string 9</last_name>
<num1>1</num1>
<num2>1</num2>
<num3>1</num3>
<num4>1</num4>
<num5>1</num5>
<phone1>sample string 12</phone1>
<phone2>sample string 13</phone2>
<sms>sample string 7</sms>
<street>sample string 14</street>
<zip_code>sample string 15</zip_code>
</ContactContainerItem>
</ArrayOfContactContainerItem>