POST api/list/groups?pageSize={pageSize}&pageNumber={pageNumber}

Groups. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
pageSize	The page size value supplied with the request.	integer	Default value is 20
pageNumber	The page number value supplied with the request.	integer	Default value is 1

Body Parameters

The group list filter data contract supplied with the request.

GroupListFilterDataContract

Name	Description	Type	Additional information
BedroomsMin	The bedrooms min value.	integer	None.
BedroomsMax	The bedrooms max value.	integer	None.
Garage	Indicates whether garage is true.	boolean	None.
Garden	Indicates whether garden is true.	boolean	None.
PriceFrom	The price from value.	integer	None.
PriceTo	The price to value.	integer	None.
PriceType	The price type value.	string	None.
TagIds	The unique identifiers of the related tag resources.	Collection of integer	None.
Grades	The collection of grades.	Collection of string	None.
RoleTypes	The collection of role types.	Collection of string	None.
SourceId	The unique identifier of the related source resource.	integer	None.
OwningTeamIds	The unique identifiers of the related owning team resources.	Collection of integer	None.
MatchType	The match type classification.	MatchType	None.
FinancialStatus	The collection of financial status.	Collection of string	None.
LastContactedFrom	The last contacted from, expressed as a date and time.	date	None.
LastContactedTo	The last contacted to, expressed as a date and time.	date	None.
LastContacted	The last contacted value.	DateRangeFilterDataContract	None.
TargetMoveInFrom	The target move in from, expressed as a date and time.	date	None.
TargetMoveInTo	The target move in to, expressed as a date and time.	date	None.
TargetMoveIn	The target move in value.	DateRangeFilterDataContract	None.
CreatedFrom	The created from, expressed as a date and time.	date	None.
CreatedTo	The created to, expressed as a date and time.	date	None.
Created	The created value.	DateRangeFilterDataContract	None.
SearchStatuses	The collection of search statuses.	Collection of string	None.
Sort	The sort classification.	GroupListSort	None.
Ids	The unique identifiers of the related api resources.	Collection of integer	None.
GroupIds	The unique identifiers of the related group resources.	Collection of integer	None.
ExcludeInactive	Indicates whether exclude inactive is true.	boolean	None.
AdditionalIds	The unique identifiers of the related additional resources.	Collection of integer	None.
ExcludedIds	The unique identifiers of the related excluded resources.	Collection of integer	None.
RegionIds	The unique identifiers of the related region resources.	Collection of integer	None.
RegionSource	The region source value.	string	None.
RegionType	The region type value.	string	None.
FindIntersectingRegions	Indicates whether find intersecting regions is true.	boolean	None.
ExcludeHasNoEmail	Indicates whether exclude has no email is true.	boolean	None.
Name	The name value.	string	None.
CustomFilterConfig	The custom filter config value.	string	None.
BranchId	The unique identifier of the related branch resource.	integer	None.
BranchIds	The unique identifiers of the related branch resources.	Collection of integer	None.
EventBranchIds	The unique identifiers of the related event branch resources.	Collection of integer	None.
Order	The order classification.	ListOrder	None.
SearchTerm	The search term value.	string	None.
FilterType	The filter type value.	EnumDataContract	None.
ShowDeleted	Indicates whether show deleted is true.	boolean	None.
ShowCancelled	Indicates whether show cancelled is true.	boolean	None.
OwningTeamId	The unique identifier of the related owning team resource.	integer	None.
Id	The unique identifier of this resource.	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "BedroomsMin": 1,
  "BedroomsMax": 1,
  "Garage": true,
  "Garden": true,
  "PriceFrom": 1,
  "PriceTo": 1,
  "PriceType": "sample string 2",
  "TagIds": [
    1,
    2
  ],
  "Grades": [
    "sample string 1",
    "sample string 2"
  ],
  "RoleTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "SourceId": 1,
  "OwningTeamIds": [
    1,
    2
  ],
  "MatchType": 0,
  "FinancialStatus": [
    "sample string 1",
    "sample string 2"
  ],
  "LastContactedFrom": "2026-08-05T00:20:08.7848504Z",
  "LastContactedTo": "2026-08-05T00:20:08.7848504Z",
  "LastContacted": {
    "FromStaticDate": "2026-08-05T00:20:08.7848504Z",
    "ToStaticDate": "2026-08-05T00:20:08.7848504Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "TargetMoveInFrom": "2026-08-05T00:20:08.7848504Z",
  "TargetMoveInTo": "2026-08-05T00:20:08.7848504Z",
  "TargetMoveIn": {
    "FromStaticDate": "2026-08-05T00:20:08.7848504Z",
    "ToStaticDate": "2026-08-05T00:20:08.7848504Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "CreatedFrom": "2026-08-05T00:20:08.7848504Z",
  "CreatedTo": "2026-08-05T00:20:08.7848504Z",
  "Created": {
    "FromStaticDate": "2026-08-05T00:20:08.7848504Z",
    "ToStaticDate": "2026-08-05T00:20:08.7848504Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "SearchStatuses": [
    "sample string 1",
    "sample string 2"
  ],
  "Sort": 0,
  "Ids": [
    1,
    2
  ],
  "GroupIds": [
    1,
    2
  ],
  "ExcludeInactive": true,
  "AdditionalIds": [
    1,
    2
  ],
  "ExcludedIds": [
    1,
    2
  ],
  "RegionIds": [
    1,
    2
  ],
  "RegionSource": "sample string 4",
  "RegionType": "sample string 5",
  "FindIntersectingRegions": true,
  "ExcludeHasNoEmail": true,
  "Name": "sample string 7",
  "CustomFilterConfig": "sample string 8",
  "BranchId": 1,
  "BranchIds": [
    1,
    2
  ],
  "EventBranchIds": [
    1,
    2
  ],
  "Order": 0,
  "SearchTerm": "sample string 9",
  "FilterType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ShowDeleted": true,
  "ShowCancelled": true,
  "OwningTeamId": 12,
  "Id": 13
}

Response Information

Resource Description

The response returned after the operation completes.

PagedCollectionDataContractOfGroupListDataContract

Name	Description	Type	Additional information
TotalCount	The total count value.	integer	None.
CurrentCount	The current count value.	integer	None.
PageSize	The page size value.	integer	None.
PageNumber	The page number value.	integer	None.
Collection	The collection of collection.	Collection of GroupListDataContract	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "Group": {
        "Description": "sample string 1",
        "GroupIcon": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "PrimaryGroupMember": {
          "Title": "sample string 1",
          "FirstName": "sample string 2",
          "LastName": "sample string 3",
          "ContactName": "sample string 4",
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Id": 5
        },
        "Members": [
          {
            "Title": "sample string 1",
            "FirstName": "sample string 2",
            "LastName": "sample string 3",
            "ContactName": "sample string 4",
            "PrimaryEmail": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "PrimaryTelephone": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "Gender": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Id": 5
          },
          {
            "Title": "sample string 1",
            "FirstName": "sample string 2",
            "LastName": "sample string 3",
            "ContactName": "sample string 4",
            "PrimaryEmail": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "PrimaryTelephone": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "Gender": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Id": 5
          }
        ],
        "OwningTeamId": 2,
        "BranchId": 3,
        "Name": "sample string 4",
        "TeamAccessType": "sample string 5",
        "GroupType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "CreatedDate": "2026-08-05T00:20:08.7848504Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 7
      },
      "Criteria": {
        "MinimumBedrooms": 1,
        "BudgetFrom": 1,
        "BudgetTo": 1,
        "TagIds": [
          1,
          2
        ],
        "PriceType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "TargetMoveIn": "2026-08-05T00:20:08.7848504Z",
        "TermType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Students": true,
        "IsSmoker": true,
        "PetOwner": true,
        "HousingBenefits": true,
        "FurnishLevelType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        }
      },
      "Grade": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Origins": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        }
      ],
      "DateLastContacted": "2026-08-05T00:20:08.7848504Z",
      "ViewingDates": [
        "2026-08-05T00:20:08.7848504Z",
        "2026-08-05T00:20:08.7848504Z"
      ],
      "OwningTeam": {
        "Name": "sample string 1",
        "Description": "sample string 2",
        "Id": 3
      },
      "RoleType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FinancialStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Viewings": 1,
      "Offers": 2,
      "TelephoneCalls": 3,
      "EmailsSent": 4,
      "Dates": {
        "sample string 1": "2026-08-05T00:20:08.7848504Z",
        "sample string 3": "2026-08-05T00:20:08.7848504Z"
      },
      "OwningTeamId": 5,
      "BranchId": 6,
      "Name": "sample string 7",
      "TeamAccessType": "sample string 8",
      "Id": 9
    },
    {
      "Group": {
        "Description": "sample string 1",
        "GroupIcon": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "PrimaryGroupMember": {
          "Title": "sample string 1",
          "FirstName": "sample string 2",
          "LastName": "sample string 3",
          "ContactName": "sample string 4",
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Id": 5
        },
        "Members": [
          {
            "Title": "sample string 1",
            "FirstName": "sample string 2",
            "LastName": "sample string 3",
            "ContactName": "sample string 4",
            "PrimaryEmail": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "PrimaryTelephone": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "Gender": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Id": 5
          },
          {
            "Title": "sample string 1",
            "FirstName": "sample string 2",
            "LastName": "sample string 3",
            "ContactName": "sample string 4",
            "PrimaryEmail": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "PrimaryTelephone": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "Gender": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Id": 5
          }
        ],
        "OwningTeamId": 2,
        "BranchId": 3,
        "Name": "sample string 4",
        "TeamAccessType": "sample string 5",
        "GroupType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "CreatedDate": "2026-08-05T00:20:08.7848504Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 7
      },
      "Criteria": {
        "MinimumBedrooms": 1,
        "BudgetFrom": 1,
        "BudgetTo": 1,
        "TagIds": [
          1,
          2
        ],
        "PriceType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "TargetMoveIn": "2026-08-05T00:20:08.7848504Z",
        "TermType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Students": true,
        "IsSmoker": true,
        "PetOwner": true,
        "HousingBenefits": true,
        "FurnishLevelType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        }
      },
      "Grade": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Origins": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        }
      ],
      "DateLastContacted": "2026-08-05T00:20:08.7848504Z",
      "ViewingDates": [
        "2026-08-05T00:20:08.7848504Z",
        "2026-08-05T00:20:08.7848504Z"
      ],
      "OwningTeam": {
        "Name": "sample string 1",
        "Description": "sample string 2",
        "Id": 3
      },
      "RoleType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FinancialStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Viewings": 1,
      "Offers": 2,
      "TelephoneCalls": 3,
      "EmailsSent": 4,
      "Dates": {
        "sample string 1": "2026-08-05T00:20:08.7848504Z",
        "sample string 3": "2026-08-05T00:20:08.7848504Z"
      },
      "OwningTeamId": 5,
      "BranchId": 6,
      "Name": "sample string 7",
      "TeamAccessType": "sample string 8",
      "Id": 9
    }
  ]
}