This API is used for getting a particular contact information
Parameter | Required | Type | Description |
---|---|---|---|
apikey | yes | string | Your authorized API key |
secret | yes | string | Your authorized secret key |
user_id | yes | string | Unique ID of the user |
business_id | yes | string | Unique ID of the business |
contact_id | yes | string | Unique ID of the contact |
phone_number | no | number | User's Phone number |
email_address | no | string | User's email address |
{ "status": "success", "status_code": 200, "message": "Contact details found", "result": { "contacts": { "birthday": { "date": date, "month": month }, "first_name": "your first name", "last_name": "your last name", "phone_number": [ "xxxxxxxxxxxx" ], "phone_list": [ "xxxxxxxxxxx" ], "email_address": [], "title": "title", "company": "company", "website": "website", "im_account": "", "im_type": "", "im_address": "", "bio_info": "", "fb_profile": "", "tw_profile": "", "gp_profile": "", "link_profile": "", "profile_image": "", "tags": [ { "_id": "xxxxxxxxxxxxxxxxxxxxx", "tag_name": "birthday", "created_date": "created date" } ], "source": "contact", "_id": "xxxxxxxxxxxxxxxxxxxxx", "user_id": "xxxxxxxxxxxxxxxxxxxxx", "business_id": "xxxxxxxxxxxxxxxxxxxxx", "created_date": "created date", "updated_date": "updated date", "__v": 0 } } }
Error Code | Description |
---|---|
701 | User id parameter required |
702 | User id is required |
610 | Invalid user id |
701 | Business id parameter required |
702 | Business id required |
610 | Invalid business id |
613 | Invalid user and business |
701 | Contact id, phone number or email address parameter required |
610 | Invalid contact Id |
204 | No record Found |
{ "error": { "reason": "parameter missing", "message": "User id parameter required", "field_name": "user_id", "code": 701, "error_type": "missing_parameter" } }
{ "error": { "reason": "required field", "message": "User id is required", "code": 702, "error_type": "required" } }
{ "error": { "errors": [ { "reason": "Invalid Id", "message": "Please make sure you have provided the valid user id" } ], "code": 610, "error_type": "reference_error" } }
{ "error": { "reason": "parameter missing", "message": "Business id parameter required", "field_name": "business_id", "code": 701, "error_type": "missing_parameter" } }
{ "error": { "reason": "required field", "message": "Business id required", "code": 702, "error_type": "required" } }
{ "error": { "errors": [ { "reason": "Invalid Id", "message": "Please make sure you have provided the valid business id" } ], "code": 610, "error_type": "reference_error" } }
{ "error": { "errors": [ { "reason": "Invalid user and business", "message": "The business and user id combination that you provided doesn't match in our record" } ], "code": 613, "error_type": "invalid_user_business" } }
{ "error": { "reason": "parameter missing", "message": "Contact id, phone number or email address parameter required", "field_name": "contact_id, phone_number, email_address", "code": 701, "error_type": "missing_parameter" } }
{ "error": { "reason": "Invalid Id", "message": "Please make sure you have provided the valid Contact id", "code": 610, "error_type": "reference_error" } }
{ "status": "no_record", "status_code": 204, "message": "No record found" }
Loading please wait...