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

Get list of groups and what they are interested in.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pageSize

integer

Default value is 20

pageNumber

integer

Default value is 1

Body Parameters

Dezrez.Core.DataContracts.External.Api.Lists.GroupInterests.GroupInterestListFilterDataContract
NameDescriptionTypeAdditional information
InterestFlags

Collection of string

None.

Origins

Collection of string

None.

Grades

Collection of string

None.

RoleTypes

Collection of string

None.

RoleStatuses

Collection of string

None.

LastContactedFrom

date

None.

LastContactedTo

date

None.

LastContacted

Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract

None.

CreatedFrom

date

None.

CreatedTo

date

None.

Created

Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract

None.

LandlordVendorFrom

date

None.

LandlordVendorTo

date

None.

LandlordVendor

Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract

None.

Sort

Dezrez.Core.DataContracts.External.Api.Lists.GroupInterests.GroupInterestListSort

None.

GroupIds

Collection of integer

None.

OwningTeamIds

Collection of integer

None.

RoleIds

Collection of integer

None.

AdditionalIds

Collection of integer

None.

ExcludedIds

Collection of integer

None.

ExcludeHasNoEmail

boolean

None.

IsMarketingRoleTypeSearch

boolean

None.

HasValuationBooked

boolean

None.

HasSearch

boolean

None.

CompanyTypes

Collection of string

None.

Archived

boolean

None.

Name

string

None.

CustomFilterConfig

string

None.

BranchId

integer

None.

BranchIds

Collection of integer

None.

EventBranchIds

Collection of integer

None.

Order

Dezrez.Core.DataContracts.External.Api.Lists.ListOrder

None.

SearchTerm

string

None.

FilterType

Dezrez.Core.DataContracts.External.Api.System.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:
{
  "InterestFlags": [
    "sample string 1",
    "sample string 2"
  ],
  "Origins": [
    "sample string 1",
    "sample string 2"
  ],
  "Grades": [
    "sample string 1",
    "sample string 2"
  ],
  "RoleTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "RoleStatuses": [
    "sample string 1",
    "sample string 2"
  ],
  "LastContactedFrom": "2024-03-29T14:55:27.0906936Z",
  "LastContactedTo": "2024-03-29T14:55:27.0906936Z",
  "LastContacted": {
    "FromStaticDate": "2024-03-29T14:55:27.0906936Z",
    "ToStaticDate": "2024-03-29T14:55:27.0906936Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "CreatedFrom": "2024-03-29T14:55:27.0906936Z",
  "CreatedTo": "2024-03-29T14:55:27.0906936Z",
  "Created": {
    "FromStaticDate": "2024-03-29T14:55:27.0906936Z",
    "ToStaticDate": "2024-03-29T14:55:27.0906936Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "LandlordVendorFrom": "2024-03-29T14:55:27.0906936Z",
  "LandlordVendorTo": "2024-03-29T14:55:27.0906936Z",
  "LandlordVendor": {
    "FromStaticDate": "2024-03-29T14:55:27.0906936Z",
    "ToStaticDate": "2024-03-29T14:55:27.0906936Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "Sort": 0,
  "GroupIds": [
    1,
    2
  ],
  "OwningTeamIds": [
    1,
    2
  ],
  "RoleIds": [
    1,
    2
  ],
  "AdditionalIds": [
    1,
    2
  ],
  "ExcludedIds": [
    1,
    2
  ],
  "ExcludeHasNoEmail": true,
  "IsMarketingRoleTypeSearch": true,
  "HasValuationBooked": true,
  "HasSearch": true,
  "CompanyTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "Archived": true,
  "Name": "sample string 2",
  "CustomFilterConfig": "sample string 3",
  "BranchId": 1,
  "BranchIds": [
    1,
    2
  ],
  "EventBranchIds": [
    1,
    2
  ],
  "Order": 0,
  "SearchTerm": "sample string 4",
  "FilterType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ShowDeleted": true,
  "ShowCancelled": true,
  "OwningTeamId": 7,
  "Id": 8
}

Response Information

Resource Description

PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Lists.GroupInterests.GroupInterestListDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of Dezrez.Core.DataContracts.External.Api.Lists.GroupInterests.GroupInterestListDataContract

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": "2024-03-29T14:55:27.0906936Z",
        "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
      },
      "InterestFlags": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        }
      ],
      "DateLastContacted": "2024-03-29T14:55:27.0906936Z",
      "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"
        }
      ],
      "RoleType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "RoleStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Viewings": 1,
      "Offers": 2,
      "TelephoneCalls": 3,
      "EmailsSent": 4,
      "OwningTeam": {
        "Name": "sample string 1",
        "Description": "sample string 2",
        "Id": 3
      },
      "MarketingRoles": [
        {
          "StartDate": "2024-03-29T14:55:27.0906936Z",
          "CompletedDate": "2024-03-29T14:55:27.0906936Z",
          "Name": "sample string 1",
          "RoleType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Rolestatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "RequestedLotNumber": 1,
          "PropertyAddress": "sample string 2",
          "GroupName": "sample string 3",
          "CompletedMilestones": 1,
          "TotalMilestones": 1,
          "PropertyId": 4,
          "Id": 5
        },
        {
          "StartDate": "2024-03-29T14:55:27.0906936Z",
          "CompletedDate": "2024-03-29T14:55:27.0906936Z",
          "Name": "sample string 1",
          "RoleType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Rolestatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "RequestedLotNumber": 1,
          "PropertyAddress": "sample string 2",
          "GroupName": "sample string 3",
          "CompletedMilestones": 1,
          "TotalMilestones": 1,
          "PropertyId": 4,
          "Id": 5
        }
      ],
      "HasSalesSearch": true,
      "HasLettingsSearch": true,
      "SystemStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Id": 5
    },
    {
      "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": "2024-03-29T14:55:27.0906936Z",
        "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
      },
      "InterestFlags": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        }
      ],
      "DateLastContacted": "2024-03-29T14:55:27.0906936Z",
      "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"
        }
      ],
      "RoleType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "RoleStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Viewings": 1,
      "Offers": 2,
      "TelephoneCalls": 3,
      "EmailsSent": 4,
      "OwningTeam": {
        "Name": "sample string 1",
        "Description": "sample string 2",
        "Id": 3
      },
      "MarketingRoles": [
        {
          "StartDate": "2024-03-29T14:55:27.0906936Z",
          "CompletedDate": "2024-03-29T14:55:27.0906936Z",
          "Name": "sample string 1",
          "RoleType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Rolestatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "RequestedLotNumber": 1,
          "PropertyAddress": "sample string 2",
          "GroupName": "sample string 3",
          "CompletedMilestones": 1,
          "TotalMilestones": 1,
          "PropertyId": 4,
          "Id": 5
        },
        {
          "StartDate": "2024-03-29T14:55:27.0906936Z",
          "CompletedDate": "2024-03-29T14:55:27.0906936Z",
          "Name": "sample string 1",
          "RoleType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Rolestatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "RequestedLotNumber": 1,
          "PropertyAddress": "sample string 2",
          "GroupName": "sample string 3",
          "CompletedMilestones": 1,
          "TotalMilestones": 1,
          "PropertyId": 4,
          "Id": 5
        }
      ],
      "HasSalesSearch": true,
      "HasLettingsSearch": true,
      "SystemStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Id": 5
    }
  ]
}