Search Contacts
Searches active contacts using a full-text search string and paginates the results. Additional structured filters can be layered on via the query string (for example, ?s=rob&country=United%20States&tag=Premium); any unrecognized query-string key is parsed as a search filter. Deleted and spam contacts are excluded.
Query Parameters
sstringrequired
Search criteria
pageIndexnumber
Offset from total records
pageSizenumber
Number of records to include in result set
HTTP Response Examples
200
{
"PageIndex": 0,
"TotalCount": 129,
"PageSize": 25,
"PageOffset": 0,
"TotalPages": 6,
"HasMoreResults": true,
"Status": true,
"Message": "",
"Response": {
"results": [
{
"tenantId": 0,
"dsId": "65d6711394204272a00191cbb3dcfcc2",
"salutation": "",
"firstName": "",
"lastName": "",
"donotcontact": false,
"maxContactFrequencyInDays": 0,
"optOutEmail": false,
"optOutSms": false,
"optOutPush": false,
"optOutPhone": false,
"isPushEnabled": false,
"isWebPushEnabled": false,
"isSmsEnabled": true,
"isEmailEnabled": true,
"isEmailVerifiedForDelivery": false,
"isSMSVerified": false,
"fullname": "rob@example.com",
"email": "rob@example.com",
"title": "",
"status": "Active",
"company": "",
"numberOfEmployees": 0,
"industry": 0,
"annualRevenue": 0,
"website": "",
"phone": "",
"mobilePhone": "",
"homePhone": "",
"timezone": "",
"avatarPath": "",
"country": "",
"city": "",
"postalCode": "",
"address": "",
"geoCode": "",
"dateFirstSeen": "1753-01-01T00:00:00+00:00",
"dateLastSeen": "1753-01-01T00:00:00+00:00",
"region": "",
"gender": 0,
"age": 0,
"extendedProperties": {
},
"dateContactCreated": "2025-06-23T22:35:29+00:00",
"timestampCreated": "2025-09-24T20:42:44.3749252Z",
"dateContactLastModified": "2025-07-02T17:01:20.77+00:00",
"dateLastContacted": "0001-01-01T00:00:00",
"accountId": 0
},
{
"tenantId": 0,
"dsId": "552e062519b44cdf9426480cbba38be6",
"salutation": "",
"firstName": "",
"lastName": "",
"donotcontact": false,
"maxContactFrequencyInDays": 0,
"optOutEmail": false,
"optOutSms": false,
"optOutPush": false,
"optOutPhone": false,
"isPushEnabled": false,
"isWebPushEnabled": false,
"isSmsEnabled": true,
"isEmailEnabled": true,
"isEmailVerifiedForDelivery": false,
"isSMSVerified": false,
"fullname": "joe@example.com",
"email": "joe@example.com",
"title": "",
"status": "Active",
"company": "",
"numberOfEmployees": 0,
"industry": 0,
"annualRevenue": 0,
"website": "",
"phone": "",
"mobilePhone": "",
"homePhone": "",
"timezone": "",
"avatarPath": "",
"country": "",
"city": "",
"postalCode": "",
"address": "",
"geoCode": "",
"dateFirstSeen": "1753-01-01T00:00:00+00:00",
"dateLastSeen": "1753-01-01T00:00:00+00:00",
"region": "",
"gender": 0,
"age": 0,
"extendedProperties": {
},
"dateContactCreated": "2025-04-25T16:24:03+00:00",
"timestampCreated": "2025-09-24T20:42:44.3749252Z",
"dateContactLastModified": "2025-07-02T18:06:08.417+00:00",
"dateLastContacted": "0001-01-01T00:00:00",
"accountId": 0
}
]
}
}
HTTP Response Parameters
PageIndexnumber
A zero based index on the number of pages available.
TotalCountnumber
Total number of results available.
PageSizenumber
The number of records returned per-paged result.
TotalPagesnumber
The total number of pages available.
HasMoreResultsbool
If there are additional results past the current page.
Response.resultsarray
An array of contact objects.