Get a List of Contacts by Group

Retrieve a list of Contacts in a paginated format using the Contact Group Id

Query String Parameters

Name	Type	Description	Required
Action	String	ContactListByGroupPaged	Required
GroupId	Int	The unique identifier of the contact group.	Required
Page	Int	The page number to return, starting from page 0.	Required
Pagesize	Int	The number of rows to be included in each page Minimum 1 Maximum 5000 .	Required
LastUpdated	DateTime	Date and Time.	Optional
IncludeExtra	Bool	Include ContactExtra data items. 1 = true, 0 = false (default).	Optional

Response Codes

Code	Message	Information
0	Response Data	See 'Response' example tab
2	GroupId or ContactGroupName parameter required	Mandatory parameter was not supplied
2	The contact group parameters are incorrect.	Contact Group does not exist
2	page parameter required	Mandatory parameter was not supplied
2	page size required	Mandatory parameter was not supplied
2	page size is smaller than or equal to 0	Mandatory parameter was not supplied
2	misc_noRight	You do not have the permissions to view contacts.

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=contactlistbygrouppaged&groupid=8503&page=0&pagesize=5

Response

Response Data

{
  "Code": 0,
  "Result": [
    {
      "Id": 935279,
      "GroupId": 8503,
      "Name": "Test",
      "Street": "Redacted Street",
      "PostCode": "LS2 9LY",
      "Town": "Leeds",
      "Country": "United Kingdom",
      "Person": "John Doe",
      "Phone": "Redacted Phone",
      "Email": "Redacted Email",
      "Extra": "",
      "Lat": 53.806214,
      "Lng": -1.56043,
      "Flagged": false,
      "ParentId": null,
      "FlaggedReason": false,
      "Group": "Test",
      "DeletionDate": null,
      "ExpiryDate": null,
      "Radius": 20,
      "contactParentReference": null,
      "contactParentName": null,
      "ContactReference": "TE 1234",
      "OnStop": 0
    },
    {
      "Id": 1083206,
      "GroupId": 8503,
      "Name": "Little Plumpton Cheeses Ltd",
      "Street": "Redacted Street",
      "PostCode": "PR4 5NG",
      "Town": "Little Plumpton",
      "Country": "United Kingdom",
      "Person": "Jane Doe",
      "Phone": "Redacted Phone",
      "Email": "Redacted Email",
      "Extra": "",
      "Lat": 53.786251,
      "Lng": -2.944405,
      "Flagged": false,
      "ParentId": null,
      "FlaggedReason": false,
      "Group": "Test",
      "DeletionDate": null,
      "ExpiryDate": null,
      "Radius": 20,
      "contactParentReference": null,
      "contactParentName": null,
      "ContactReference": null,
      "OnStop": 0
    }
  ]
}