Get a Paged List of Contacts by Group

Retrieve a list of contacts

Query String Parameters

Name	Type	Description	Required
Action	String	ContactListPersonByGroup	Required
ContactGroupId	Int	The unique identifier of the contact note group which can be retrieved using Contact Groups	Optional
Page	Int	Page Number	Optional
PageSize	Int	The number of rows to be included in each page. Allowed Values: 1 - 5000.	Optional

Response Codes

Code	Message	Information
0	Response Data	See 'Response' example tab
2	Page Parameter Required	Mandatory parameter was not supplied
2	Contact Group Name or Id must be specified	Mandatory parameter was not supplied
2	Invalid parameter - contactgroupId	Integer value is invalid or was not specified (when required)
2	Invalid Page Number	Integer value is invalid or was not specified (when required)
2	Invalid Page Size	Integer value is invalid or was not specified (when required)
2	No matching contact group	No data returned or set-up in BigChange
2	There are no contacts in this group	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=ContactListPersonByGroup&ContactGroupId=51565&Page=1&PageSize=20

Response

Response Data

{
  "Code": 0,
  "Result": [
    {
      "ContactId": 8397722,
      "ContactName": "Joe Bloggs Solicitors",
      "ContactUserUid": "3e8aaefe-3246-4832-98d3-9cf1d65d7347",
      "Title": "",
      "FirstName": "Joe",
      "Surname": "Bloggs",
      "FullName": "Joe Bloggs",
      "Email": "",
      "Position": "",
      "Department": "",
      "Phone": "+4419992460055",
      "Landline": "",
      "LandlineExtension": "",
      "Flags": []
    },
    {
      "ContactId": 8427959,
      "ContactName": "John Smiths Services Ltd",
      "ContactUserUid": "37356c14-461b-41ec-aa05-97a90b764c5b",
      "Title": "",
      "FirstName": "John",
      "Surname": "Smith",
      "FullName": "John SMith",
      "Email": "",
      "Position": "",
      "Department": "",
      "Phone": "+441999633323",
      "Landline": "",
      "LandlineExtension": "",
      "Flags": []
    },
    {
      "ContactId": 9729701,
      "ContactName": "Company Names Ltd",
      "ContactUserUid": "30563942-195f-4cc6-ba9d-2cb8a6a0d5ef",
      "Title": "",
      "FirstName": "Arthur",
      "Surname": "Jones",
      "FullName": "Arthur Jones",
      "Email": "",
      "Position": "",
      "Department": "",
      "Phone": "",
      "Landline": "+444441237999",
      "LandlineExtension": "",
      "Flags": []
    }
  ]
}