Get a List of Contacts By Parent
Retrieve a list of Contact Id's that have the supplied Contact as their Parent.
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | ContactsByParent | Required |
ContactId | Int | The unique identifier of the contact which can be retrieved using Contact List. | Optional |
ContactReference | String(50) | The internal reference of the contact. The Contact Reference or Id can be supplied. If both parameters are provided, the Contact Id will take precedence. | Optional |
Response Codes
Code | Message | Information |
---|---|---|
0 | Response Data | See 'Response' example tab |
2 | contactId or contactRef parameters required | Mandatory parameter was not supplied |
2 | invalid parameter - contactId | Integer value is invalid or was not specified (when required) |
2 | No matching contact | No data returned or set-up in BigChange |
2 | misc_noRight | You do not have the permissions to create and update contacts. |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=contactsbyparent&contactid=1759881
Response Data
{ "Code": 0, "Result": [ { "ContactId": 1759882 }, { "ContactId": 1759883 }, { "ContactId": 1759884 } ] }