GET / Search Contacts

Search for Contacts by Name or Email Address

GET /v2/contact/all/$listId?sort={desc}&search={$string}&offset={offset}

Search for Contacts by Engagement Status

GET /v2/contact/all/$listId?engagement={$status}

Header

HTTP/1.1
Authorization: Bearer $api_id.$api_secret
Host: api.$app_domain
Accept: application/json

Parameters

1. The ‘asc’ parameter should be used for the A-Z sorting option and ‘desc’ for Z-A. If left blank or no ‘sort’ param at all, the default sorting logic is by date added.
2. The ‘search’ $string should be passed as a url encoded value.
3. The ‘offset’ will be returned by the previous call and must be passed to the next call in the query string. It’s a number, multiple of '50'. When the record set is done, we will return a '0' offset and the pagination will be stopped.

Response

{
“contacts”: [{
    "id": "1332994",
    "list_id": "6641",
    "email": "jerry@seinfeld.io",
    "name": "Jerry Seinfeld",
    "time": "1665178145",
    "changed_time": "0",
    "new_time": "1665178145",
    "status": "0",
    "bounce_count": "0",
    "ooo_date": "0",
     "timeline_profile_url": "https:\/\/$app_domain\/contact-1332994"

}, {
    "id": "1263044",
    "list_id": "6641",
    "email": "elon1@tesla.io",
    "name": "Elon Musk",
    "time": "1640884194",
    "changed_time": "0",
    "new_time": "1663262168",
    "status": "0",
    "bounce_count": "0",
    "ooo_date": "0",
    "timeline_profile_url": "https:\/\/$app_domain\/contact-1263044"
}], 
“offset”: 250
}

Response data types

Error code

HTTP/1.1 404 Not Found
{
    "id": "0",
    "message": "Error description"
}