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

Request Information

URI Parameters

Name	Description	Type	Additional information
pageSize		integer	Default value is 20
pageNumber		integer	Default value is 1

Body Parameters

GroupListFilterDataContract

Name	Type	Additional information
BedroomsMin	integer	None.
PriceFrom	integer	None.
PriceTo	integer	None.
PriceType	string	None.
TagIds	Collection of integer	None.
Grades	Collection of string	None.
RoleTypes	Collection of string	None.
SourceId	integer	None.
OwningTeamIds	Collection of integer	None.
MatchType	MatchType	None.
FinancialStatus	Collection of string	None.
LastContactedFrom	date	None.
LastContactedTo	date	None.
LastContacted	DateRangeFilterDataContract	None.
TargetMoveInFrom	date	None.
TargetMoveInTo	date	None.
TargetMoveIn	DateRangeFilterDataContract	None.
CreatedFrom	date	None.
CreatedTo	date	None.
Created	DateRangeFilterDataContract	None.
SearchStatuses	Collection of string	None.
Sort	GroupListSort	None.
Ids	Collection of integer	None.
GroupIds	Collection of integer	None.
ExcludeInactive	boolean	None.
AdditionalIds	Collection of integer	None.
ExcludedIds	Collection of integer	None.
RegionIds	Collection of integer	None.
RegionSource	string	None.
RegionType	string	None.
FindIntersectingRegions	boolean	None.
ExcludeHasNoEmail	boolean	None.
Name	string	None.
CustomFilterConfig	string	None.
BranchId	integer	None.
BranchIds	Collection of integer	None.
EventBranchIds	Collection of integer	None.
Order	ListOrder	None.
SearchTerm	string	None.
FilterType	EnumDataContract	None.
ShowDeleted	boolean	None.
ShowCancelled	boolean	None.
OwningTeamId	integer	None.
Id	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "BedroomsMin": 1,
  "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": "2025-11-13T02:40:26.0260929Z",
  "LastContactedTo": "2025-11-13T02:40:26.0260929Z",
  "LastContacted": {
    "FromStaticDate": "2025-11-13T02:40:26.0260929Z",
    "ToStaticDate": "2025-11-13T02:40:26.0260929Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "TargetMoveInFrom": "2025-11-13T02:40:26.0260929Z",
  "TargetMoveInTo": "2025-11-13T02:40:26.0260929Z",
  "TargetMoveIn": {
    "FromStaticDate": "2025-11-13T02:40:26.0260929Z",
    "ToStaticDate": "2025-11-13T02:40:26.0260929Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "CreatedFrom": "2025-11-13T02:40:26.0260929Z",
  "CreatedTo": "2025-11-13T02:40:26.0260929Z",
  "Created": {
    "FromStaticDate": "2025-11-13T02:40:26.0260929Z",
    "ToStaticDate": "2025-11-13T02:40:26.0260929Z",
    "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

PagedCollectionDataContractOfGroupListDataContract

Name	Type	Additional information
TotalCount	integer	None.
CurrentCount	integer	None.
PageSize	integer	None.
PageNumber	integer	None.
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": "2025-11-13T02:40:26.0260929Z",
        "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": "2025-11-13T02:40:26.0260929Z",
        "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": "2025-11-13T02:40:26.0260929Z",
      "ViewingDates": [
        "2025-11-13T02:40:26.0260929Z",
        "2025-11-13T02:40:26.0260929Z"
      ],
      "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": "2025-11-13T02:40:26.0260929Z",
        "sample string 3": "2025-11-13T02:40:26.0260929Z"
      },
      "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": "2025-11-13T02:40:26.0260929Z",
        "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": "2025-11-13T02:40:26.0260929Z",
        "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": "2025-11-13T02:40:26.0260929Z",
      "ViewingDates": [
        "2025-11-13T02:40:26.0260929Z",
        "2025-11-13T02:40:26.0260929Z"
      ],
      "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": "2025-11-13T02:40:26.0260929Z",
        "sample string 3": "2025-11-13T02:40:26.0260929Z"
      },
      "OwningTeamId": 5,
      "BranchId": 6,
      "Name": "sample string 7",
      "TeamAccessType": "sample string 8",
      "Id": 9
    }
  ]
}