Get a List of Contact Users
Get a list of contact users.
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | ContactUsersList | Required |
ContactUserContactId | int | Unique Id of the contact. | Optional |
WithEmails | bool | Retrieve Users with an email address. | Optional |
WithLandlines | bool | Retrieve Users with a landline number. | Optional |
WithMobiles | bool | Retrieve Users with a mobile number. | Optional |
StartRow | int | Starting row offset, default = 0. | Optional |
RowCount | int | Number of rows to return. Default is 5000. | Optional |
Response Codes
Code | Message | Information |
---|---|---|
0 | Response Data | See 'Response' example tab |
2 | Invalid Format | 'Integer value is invalid or was not specified (when required) Refers to the 'contactusercontactid' parameter |
2 | Invalid Format - rowStart | Integer value is invalid or was not specified (when required) |
2 | Invalid Format - RowCount | Integer value is invalid or was not specified (when required) |
2 | misc_noRight | You do not have the permissions to view contacts. |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=ContactUsersList&ContactUserContactId=7348490&StartRow=1&RowCount=10
Response Data
{ "Code": 0, "Result": [ { "ContactUserContactId": 7348490, "ContactUserContactName": "A Customer", "ContactUserCustomFields": { "325182": "jjlk" }, "ContactUserDepartment": "", "ContactUserEmail": "", "ContactUserFirstName": "", "ContactUserName": ",hhjkhjkhjk", "ContactUserPhone": "", "ContactUserTagIds": [], "ContactUserCreationDate": "2021-04-01 08:19:05", "ContactUserIsMain": false, "ContactUserLandline": "", "ContactUserLandlineExtension": "", "ContactUserNoMarketing": false, "ContactUserUid": "b247aba9-8564-426a-8504-474701c28d7d" }, { "ContactUserContactId": 7348490, "ContactUserContactName": "A Customer", "ContactUserCustomFields": { "325182": "fgdfg" }, "ContactUserDepartment": "", "ContactUserEmail": "", "ContactUserFirstName": "", "ContactUserName": "Ben Testington", "ContactUserPhone": "+123456789012345", "ContactUserTagIds": [], "ContactUserCreationDate": "2021-03-08 13:36:32", "ContactUserIsMain": false, "ContactUserLandline": "", "ContactUserLandlineExtension": "", "ContactUserNoMarketing": false, "ContactUserUid": "7728cfd9-2697-4d73-8336-8fb12e424b83" }, { "ContactUserContactId": 7348490, "ContactUserContactName": "A Customer", "ContactUserCustomFields": {}, "ContactUserDepartment": "", "ContactUserEmail": "", "ContactUserFirstName": "", "ContactUserName": "Person 1", "ContactUserPhone": "", "ContactUserTagIds": [], "ContactUserCreationDate": "2020-08-03 12:16:45", "ContactUserIsMain": false, "ContactUserLandline": "", "ContactUserLandlineExtension": "", "ContactUserNoMarketing": false, "ContactUserUid": "44c63fe1-7b8a-46e7-b3ce-ef5ffd2581d6" } ] }