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
dsidstring
The dsid of the contact to lookup. Optional when providing email or mobilephone as a query parameter.
Query Parameters
emailstring
When a dsid is not provided in the URL path, find a contact by email address.
mobilephonestring
When a dsid is not provided in the URL path, find a contact by mobile phone (E.164 format recommended, e.g. +15551234567).
HTTP Response Examples
200
{
"Status": true,
"Message": "",
"Response": {
"contact": {
"tenantId": 112,
"dsId": "43aaf5af35f866b1edba7",
"firstName": "Rob",
"lastName": "Howard",
"fullname": "Rob Howard",
"email": "rob@example.com",
"mobilePhone": "+15557140059",
"status": "Active",
"donotcontact": false,
"optOutEmail": false,
"optOutSms": false,
"isEmailEnabled": true,
"isSmsEnabled": true,
"country": "United States",
"city": "Dallas",
"region": "Texas",
"postalCode": "75270",
"extendedProperties": {
"stripe_customer_id": "cus_DRvE6c5V9jp",
"class_of_license": "Premium"
},
"dateContactCreated": "2022-01-12T00:00:00",
"dateContactLastModified": "2025-09-23T20:50:49.373"
},
"id": "43aaf5af35f866b1edba7"
}
}
HTTP Response Parameters
contactobject
The contact record. Includes identity fields (dsId, firstName, lastName, email, mobilePhone), subscription flags (optOutEmail, optOutSms, isEmailEnabled, etc.), location (country, city, postalCode, geoCode), timestamps, and any extendedProperties (custom field values).
idstring
The dsid of the returned contact (convenience duplicate of contact.dsId).