Get a Contact By Email Address

Search Contact by Email and ContactId or ContactReference (ContactByEmailAddress).

Query String Parameters

Name	Type	Description	Required
Action	String	ContactByEmailAddress	Required
ContactId	Int	The unique identifier of the contact which can be retrieved using Contact List.	Optional
ContactRef	String	The internal reference of the contact. Required if ContactId is not provided	Optional
EmailAddress	String	Email address of the Contact User you would like to search for.	Optional
IncludeCustomFields	Bool	Include custom fields in the response.	Optional
IncludeFlags	Bool	Include tags in the response.	Optional

Response Codes

Code	Message	Information
0	Response Data	See 'Response' example tab
2	EmailAddress parameter required	Mandatory parameter was not supplied
2	contactId or contactRef parameters required	Mandatory parameter was not supplied
2	invalid contactId parameter	Integer value is invalid or was not specified (when required)
2	No matching contact	No data returned or set-up in BigChange
2	No contact found for {EmailAddress}	No data returned or set-up in BigChange
2	misc_noRight	You do not have the permissions to view contacts.

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=ContactByEmailAddress&ContactId=39010189&EmailAddress=lucymargetts%40outlook.com

Response

Response Data

{
  "Code": 0,
  "Result": {
    "id": 5930839,
    "label": "A Company Parent",
    "main": false,
    "ContactUserUid": "f226ab82-649f-4b44-8fc6-204e37c5b5cf"
  }
}