Get a Contact
Used to get a contact.
ImportantIt is possible for multiple contacts to share the same mobile phone or email. The first matching contact is returned by the API.
Example for how to find a contact by email address:
Find by email address /api/v1/contact?email=ben@example.com
Example for how to find a contact by mobile phone:
Find by mobile phone /api/v1/contact?mobilephone=+155512345678
Path Parameters
idstring
The dsid of the contact to lookup.
Query Parameters
emailstring
If a dsid is not provided in the URL path, a query string parameter for email may be provided to find a contact by email address.
mobilephonestring
if a dsid is not provided int he URL path, a query string parameter for mobile phone may be provided to find a contact by mobile phone number.
HTTP Response Examples
200
{
"Status": true,
"Message": "",
"Response": {
"contact": {
"tenantId": 112,
"dsId": "43aaf5af35f866b1edba7",
"salutation": "",
"firstName": "Rob",
"lastName": "Howard",
"donotcontact": false,
"maxContactFrequencyInDays": 0,
"optOutEmail": false,
"optOutSms": false,
"optOutPush": false,
"optOutPhone": false,
"isPushEnabled": false,
"isWebPushEnabled": true,
"isSmsEnabled": true,
"isEmailEnabled": true,
"isEmailVerifiedForDelivery": true,
"isSMSVerified": false,
"fullname": "Rob Howard",
"email": "rob@example.com",
"title": "Founder, CEO",
"status": "Active",
"company": "https://dailystory.com",
"numberOfEmployees": 0,
"industry": 0,
"annualRevenue": 0,
"website": "",
"phone": "+15557140059",
"mobilePhone": "+15557140059",
"homePhone": "",
"timezone": "",
"avatarPath": "",
"country": "United States",
"city": "Dallas",
"postalCode": "75270",
"address": "",
"geoCode": "33.8731,-93.8607",
"dateFirstSeen": "2021-01-16T19:24:03.283",
"dateLastSeen": "2025-09-23T20:50:49.373",
"region": "Texas",
"gender": 0,
"age": 0,
"extendedProperties": {
"stripe_customer_id": "cus_DRvE6c5V9jp",
"class_of_license": "Premium"
},
"dateContactCreated": "2022-01-12T00:00:00",
"timestampCreated": "2022-01-12T18:10:25.56",
"dateContactLastModified": "2025-09-23T20:50:49.373",
"dateLastContacted": "2025-09-23T14:21:10.293",
"accountId": 0
},
"id": "43aaf5af35f866b1edba7"
}
}