Skip to main content

Get a List of Contact Person

Returns a list of contact persons recorded for a contact.

Query String Parameters

NameTypeDescriptionRequired
ActionStringContactListPersonRequired
ContactIdIntThe unique identifier of the contact which can be retrieved using Contact List.Required
ContactRefStringThe internal reference of the contact.Optional - See Tip
DisplayMainUserBoolRequest additional field IsMainUser is included in the Response
Displays Yes or No depending on whether the user is a main user or not.
Optional

Response Codes

CodeMessageInformation
0Response DataSee 'Response' example tab
2contactId or contactRef parameters requiredMandatory parameter was not supplied
2invalid parameter - contactIdInteger value is invalid or was not specified (when required)
2No matching contactNo record found using the specified parameters
2Cannot find persons at ContactNo record found using the specified parameters
2misc_noRightYou do not have the permissions to view contacts.

Example

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=ContactListPerson&ContactRef=ABC0001&CountStatus=2