Get a Contact

Get details of specific Contact

Query String Parameters

Name	Type	Description	Required
Action	String	ContactDetail	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
IncludeDeleted	Bool	Include deleted contacts in the search if set to 1. Defaults to false (0).	Optional
IncludeDefaults	Bool	Include custom field default value if no updated value on the contact, if set to 1. Defaults to false (0)	Optional

Response Codes

Code	Message	Information
0	Response Data	See 'Response' example tab
2	contactId or contactRef parameter required	Mandatory parameter was not supplied
2	Invalid ContactId parameter.	Integer value is invalid or was not specified (when required)
2	No contacts found	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=contactdetail&contactid=38759340

Response

Response Data

{
  "Code": 0,
  "Result": {
    "Id": 38759340,
    "GroupId": 16598,
    "Name": "Joe Bloggs",
    "Street": "1 Somewhere Lane ",
    "PostCode": "LE8 8QZ",
    "Town": "Leicester",
    "Country": "",
    "Person": "",
    "Phone": "+447932123456",
    "Email": "joebloggss@someemail.com",
    "Extra": null,
    "Lat": 52.6546,
    "Lng": -1.118627,
    "Flagged": false,
    "ParentId": 30967687,
    "ParentFlagged": false,
    "ParentName": "Fred Smith",
    "ParentPerson": "",
    "ParentPhone": null,
    "ContactReference": "NewRef",
    "ParentReference": "002-new-contact",
    "AccountReference": null,
    "AccountType": null,
    "FlaggedReason": null,
    "ParentFlaggedReason": null,
    "OnStop": 0,
    "OnStopReason": null,
    "OnStopDate": null,
    "OnStopUserId": null,
    "ContactExtraDelay2Pay": null,
    "ContactExtraQuoteValidity": null,
    "ContactExtraUTR": null,
    "ContactExtraVatNum": null,
    "ContactExtraCompanyRegistrationNumber": null,
    "ContactExtraOrgType": "",
    "ContactExtraPrimarySICCode": null,
    "ContactRadius": 10,
    "ContactCustomFields": {
      "72518": "90",
      "1085853": ""
    },
    "ContactCreationDate": "2024-08-30 11:51:45",
    "Cust_NEW_FIELD": "90"
  }
}

note

Any custom fields defined for the contact group will be returned with the format "cust_fieldname" where fieldname is the caption used by the custom field.