Retrieve all contacts
http(s)://advertmaxllc.com/api/<api_key>/contact
Retrieve all subscribed contacts (exclude bounced, un-subscribed and deleted), max record to return is 100.
Response
{
"totalRecords": 4239,
"contacts": [
{
"id": 1,
"email": "demo@example.com",
"firstName": "Demo",
"lastName": "My Name"
},
...
]
}
A brief explanation
totalRecords: Total number records in our database, this request may return 100 or fewer only
Retrieve contacts by page
http(s)://advertmaxllc.com/api/<api_key>/
contact?start=0&limit=100
http(s)://advertmaxllc.com/api/<api_key>/
contact?start=100&limit=100
Return the first page and the second page, each page contains 100 records.
Response is the same as above. The max limit value is 100.
Retrieve contact
http(s)://advertmaxllc.com/api/<api_key>/
contact/<contact_id> or
http(s)://advertmaxllc.com/api/<api_key>/
contact/<email_address>
Response
{
"businessName": "",
"lastName": "Name",
"valid": false,
"phone": "",
"fax": "",
"address1": "",
"address2": "",
"bounce": false,
"city": "",
"country": "--",
"id": 0,
"email": "demo@example.com",
"gender": "F",
"businessEmail": "",
"firstName": "Demo",
"unsubscribe": false,
"businessAddress": "",
"createDt": "2011-03-30 10:07 AM",
"c_url": "http://example.com,
"c_company_fax": "123456",
...
}
Please note that the last 2 fields (c_url and c_company_fax)
are the custom field, which is defined by the user.
All custom field start with "c_".
The next section explains how to retrieve a custom field definition.
Retrieve custom field definition
http(s)://advertmaxllc.com/api/<api_key>/custom-field
This URI return the user definition of the custom field, the structure is
similar but the content is from the custom field stored by each contact.
Response
[
{"field":"c_url","value":"Website URL"}
,{"field":"c_company_fax","value":"Company Fax No."}
...
]
A brief explanation
field: custom field name
value: field caption
Retrieve all un-subscribed contacts
http(s)://advertmaxllc.com/api/<api_key>/contact/unsubscribed
This URI returns email address only.
Reponse
[
"email_1@example.com"
, "email_2@example.com"
...
]
Retrieve all bounced contacts
http(s)://advertmaxllc.com/api/<api_key>/contact/bounced
This URI returns email address only.
Reponse
[
"email_1@example.com"
, "email_2@example.com"
...
]
