Get a List of Contacts By EmailAddress

Get list of contacts using an email address

Query String Parameters

Name	Type	Description	Required
Action	String	ContactListByEmailAddress	Required
EmailAddress	String	Email address of the Contact User you would like to search for. Provide a ContactId or ContactRef to target specific contact	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.	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	misc_noRight	You do not have the permissions to view contacts.

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=contactlistbyemailaddress&emailaddress=lucymargetts%40outlook.com

Response

Response Data

{
  "Code": 0,
  "Result": [
    {
      "id": 39010189,
      "label": "Lucy Margetts",
      "main": true,
      "ContactUserUId": "5bdf1a17-ed89-475c-94ce-5a6557ec45ef",
      "FirstName": "",
      "SecondName": "",
      "Phone": "+447932883112",
      "Email": "lucymargetts@outlook.com"
    },
    {
      "id": 39010151,
      "label": "Lucy Margetts",
      "main": true,
      "ContactUserUId": "aba869f6-8700-45de-a7d8-5c016f9ed31c",
      "FirstName": "",
      "SecondName": "",
      "Phone": "+447932883112",
      "Email": "lucymargetts@outlook.com"
    }
  ]
}