GET api/business-users/me/clients/filter?propertyId={propertyId}&name={name}

This method will retrieve models for all clients created by the business user

Requires Authorization!

Request Information

URI Parameters

Name	Description	Type	Additional information
propertyId		integer	Required
name		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of

Collection of BusinessUserClientModel

Name	Type	Additional information
ClientId	integer	None.
FirstName	string	None.
LastName	string	None.
Properties	Collection of ClientPropertyModel	None.
Phone	string	None.
Email	string	None.
CellPhone	string	None.
AddedDate	date	None.
Notes	string	None.
IsBuilder	boolean	None.
NotificationsEanbled	boolean	None.
CompanyName	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "clientId": 1,
    "firstName": "sample string 2",
    "lastName": "sample string 3",
    "properties": [
      {
        "address": "sample string 1",
        "city": "sample string 2",
        "state": "sample string 3",
        "zipCode": "sample string 4",
        "purchasePrice": 1.0,
        "purchaseDate": "2025-05-20T15:33:21.6430375-05:00",
        "taxCode": "sample string 5",
        "township": "sample string 6",
        "propertyClass": "sample string 7",
        "isForeclosure": true,
        "pin": "sample string 9",
        "county": "sample string 10",
        "appealNumber": "sample string 11",
        "appealInProgress": true,
        "appealStatus": "sample string 13",
        "id": 14
      },
      {
        "address": "sample string 1",
        "city": "sample string 2",
        "state": "sample string 3",
        "zipCode": "sample string 4",
        "purchasePrice": 1.0,
        "purchaseDate": "2025-05-20T15:33:21.6430375-05:00",
        "taxCode": "sample string 5",
        "township": "sample string 6",
        "propertyClass": "sample string 7",
        "isForeclosure": true,
        "pin": "sample string 9",
        "county": "sample string 10",
        "appealNumber": "sample string 11",
        "appealInProgress": true,
        "appealStatus": "sample string 13",
        "id": 14
      }
    ],
    "phone": "sample string 4",
    "email": "sample string 5",
    "cellPhone": "sample string 6",
    "addedDate": "2025-05-20T15:33:21.6430375-05:00",
    "notes": "sample string 8",
    "isBuilder": true,
    "notificationsEanbled": true,
    "companyName": "sample string 11"
  },
  {
    "clientId": 1,
    "firstName": "sample string 2",
    "lastName": "sample string 3",
    "properties": [
      {
        "address": "sample string 1",
        "city": "sample string 2",
        "state": "sample string 3",
        "zipCode": "sample string 4",
        "purchasePrice": 1.0,
        "purchaseDate": "2025-05-20T15:33:21.6430375-05:00",
        "taxCode": "sample string 5",
        "township": "sample string 6",
        "propertyClass": "sample string 7",
        "isForeclosure": true,
        "pin": "sample string 9",
        "county": "sample string 10",
        "appealNumber": "sample string 11",
        "appealInProgress": true,
        "appealStatus": "sample string 13",
        "id": 14
      },
      {
        "address": "sample string 1",
        "city": "sample string 2",
        "state": "sample string 3",
        "zipCode": "sample string 4",
        "purchasePrice": 1.0,
        "purchaseDate": "2025-05-20T15:33:21.6430375-05:00",
        "taxCode": "sample string 5",
        "township": "sample string 6",
        "propertyClass": "sample string 7",
        "isForeclosure": true,
        "pin": "sample string 9",
        "county": "sample string 10",
        "appealNumber": "sample string 11",
        "appealInProgress": true,
        "appealStatus": "sample string 13",
        "id": 14
      }
    ],
    "phone": "sample string 4",
    "email": "sample string 5",
    "cellPhone": "sample string 6",
    "addedDate": "2025-05-20T15:33:21.6430375-05:00",
    "notes": "sample string 8",
    "isBuilder": true,
    "notificationsEanbled": true,
    "companyName": "sample string 11"
  }
]

text/html

Sample:

[{"clientId":1,"firstName":"sample string 2","lastName":"sample string 3","properties":[{"address":"sample string 1","city":"sample string 2","state":"sample string 3","zipCode":"sample string 4","purchasePrice":1.0,"purchaseDate":"2025-05-20T15:33:21.6430375-05:00","taxCode":"sample string 5","township":"sample string 6","propertyClass":"sample string 7","isForeclosure":true,"pin":"sample string 9","county":"sample string 10","appealNumber":"sample string 11","appealInProgress":true,"appealStatus":"sample string 13","id":14},{"address":"sample string 1","city":"sample string 2","state":"sample string 3","zipCode":"sample string 4","purchasePrice":1.0,"purchaseDate":"2025-05-20T15:33:21.6430375-05:00","taxCode":"sample string 5","township":"sample string 6","propertyClass":"sample string 7","isForeclosure":true,"pin":"sample string 9","county":"sample string 10","appealNumber":"sample string 11","appealInProgress":true,"appealStatus":"sample string 13","id":14}],"phone":"sample string 4","email":"sample string 5","cellPhone":"sample string 6","addedDate":"2025-05-20T15:33:21.6430375-05:00","notes":"sample string 8","isBuilder":true,"notificationsEanbled":true,"companyName":"sample string 11"},{"clientId":1,"firstName":"sample string 2","lastName":"sample string 3","properties":[{"address":"sample string 1","city":"sample string 2","state":"sample string 3","zipCode":"sample string 4","purchasePrice":1.0,"purchaseDate":"2025-05-20T15:33:21.6430375-05:00","taxCode":"sample string 5","township":"sample string 6","propertyClass":"sample string 7","isForeclosure":true,"pin":"sample string 9","county":"sample string 10","appealNumber":"sample string 11","appealInProgress":true,"appealStatus":"sample string 13","id":14},{"address":"sample string 1","city":"sample string 2","state":"sample string 3","zipCode":"sample string 4","purchasePrice":1.0,"purchaseDate":"2025-05-20T15:33:21.6430375-05:00","taxCode":"sample string 5","township":"sample string 6","propertyClass":"sample string 7","isForeclosure":true,"pin":"sample string 9","county":"sample string 10","appealNumber":"sample string 11","appealInProgress":true,"appealStatus":"sample string 13","id":14}],"phone":"sample string 4","email":"sample string 5","cellPhone":"sample string 6","addedDate":"2025-05-20T15:33:21.6430375-05:00","notes":"sample string 8","isBuilder":true,"notificationsEanbled":true,"companyName":"sample string 11"}]

application/xml, text/xml

Sample:

<ArrayOfBusinessUserClientModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Pos.Business">
  <BusinessUserClientModel>
    <AddedDate>2025-05-20T15:33:21.6430375-05:00</AddedDate>
    <CellPhone>sample string 6</CellPhone>
    <ClientId>1</ClientId>
    <CompanyName>sample string 11</CompanyName>
    <Email>sample string 5</Email>
    <FirstName>sample string 2</FirstName>
    <IsBuilder>true</IsBuilder>
    <LastName>sample string 3</LastName>
    <Notes>sample string 8</Notes>
    <NotificationsEanbled>true</NotificationsEanbled>
    <Phone>sample string 4</Phone>
    <Properties xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.PropertyBinding">
      <d3p1:ClientPropertyModel>
        <d3p1:Address>sample string 1</d3p1:Address>
        <d3p1:AppealInProgress>true</d3p1:AppealInProgress>
        <d3p1:AppealNumber>sample string 11</d3p1:AppealNumber>
        <d3p1:AppealStatus>sample string 13</d3p1:AppealStatus>
        <d3p1:City>sample string 2</d3p1:City>
        <d3p1:County>sample string 10</d3p1:County>
        <d3p1:Id>14</d3p1:Id>
        <d3p1:IsForeclosure>true</d3p1:IsForeclosure>
        <d3p1:Pin>sample string 9</d3p1:Pin>
        <d3p1:PropertyClass>sample string 7</d3p1:PropertyClass>
        <d3p1:PurchaseDate>2025-05-20T15:33:21.6430375-05:00</d3p1:PurchaseDate>
        <d3p1:PurchasePrice>1</d3p1:PurchasePrice>
        <d3p1:State>sample string 3</d3p1:State>
        <d3p1:TaxCode>sample string 5</d3p1:TaxCode>
        <d3p1:Township>sample string 6</d3p1:Township>
        <d3p1:ZipCode>sample string 4</d3p1:ZipCode>
      </d3p1:ClientPropertyModel>
      <d3p1:ClientPropertyModel>
        <d3p1:Address>sample string 1</d3p1:Address>
        <d3p1:AppealInProgress>true</d3p1:AppealInProgress>
        <d3p1:AppealNumber>sample string 11</d3p1:AppealNumber>
        <d3p1:AppealStatus>sample string 13</d3p1:AppealStatus>
        <d3p1:City>sample string 2</d3p1:City>
        <d3p1:County>sample string 10</d3p1:County>
        <d3p1:Id>14</d3p1:Id>
        <d3p1:IsForeclosure>true</d3p1:IsForeclosure>
        <d3p1:Pin>sample string 9</d3p1:Pin>
        <d3p1:PropertyClass>sample string 7</d3p1:PropertyClass>
        <d3p1:PurchaseDate>2025-05-20T15:33:21.6430375-05:00</d3p1:PurchaseDate>
        <d3p1:PurchasePrice>1</d3p1:PurchasePrice>
        <d3p1:State>sample string 3</d3p1:State>
        <d3p1:TaxCode>sample string 5</d3p1:TaxCode>
        <d3p1:Township>sample string 6</d3p1:Township>
        <d3p1:ZipCode>sample string 4</d3p1:ZipCode>
      </d3p1:ClientPropertyModel>
    </Properties>
  </BusinessUserClientModel>
  <BusinessUserClientModel>
    <AddedDate>2025-05-20T15:33:21.6430375-05:00</AddedDate>
    <CellPhone>sample string 6</CellPhone>
    <ClientId>1</ClientId>
    <CompanyName>sample string 11</CompanyName>
    <Email>sample string 5</Email>
    <FirstName>sample string 2</FirstName>
    <IsBuilder>true</IsBuilder>
    <LastName>sample string 3</LastName>
    <Notes>sample string 8</Notes>
    <NotificationsEanbled>true</NotificationsEanbled>
    <Phone>sample string 4</Phone>
    <Properties xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.PropertyBinding">
      <d3p1:ClientPropertyModel>
        <d3p1:Address>sample string 1</d3p1:Address>
        <d3p1:AppealInProgress>true</d3p1:AppealInProgress>
        <d3p1:AppealNumber>sample string 11</d3p1:AppealNumber>
        <d3p1:AppealStatus>sample string 13</d3p1:AppealStatus>
        <d3p1:City>sample string 2</d3p1:City>
        <d3p1:County>sample string 10</d3p1:County>
        <d3p1:Id>14</d3p1:Id>
        <d3p1:IsForeclosure>true</d3p1:IsForeclosure>
        <d3p1:Pin>sample string 9</d3p1:Pin>
        <d3p1:PropertyClass>sample string 7</d3p1:PropertyClass>
        <d3p1:PurchaseDate>2025-05-20T15:33:21.6430375-05:00</d3p1:PurchaseDate>
        <d3p1:PurchasePrice>1</d3p1:PurchasePrice>
        <d3p1:State>sample string 3</d3p1:State>
        <d3p1:TaxCode>sample string 5</d3p1:TaxCode>
        <d3p1:Township>sample string 6</d3p1:Township>
        <d3p1:ZipCode>sample string 4</d3p1:ZipCode>
      </d3p1:ClientPropertyModel>
      <d3p1:ClientPropertyModel>
        <d3p1:Address>sample string 1</d3p1:Address>
        <d3p1:AppealInProgress>true</d3p1:AppealInProgress>
        <d3p1:AppealNumber>sample string 11</d3p1:AppealNumber>
        <d3p1:AppealStatus>sample string 13</d3p1:AppealStatus>
        <d3p1:City>sample string 2</d3p1:City>
        <d3p1:County>sample string 10</d3p1:County>
        <d3p1:Id>14</d3p1:Id>
        <d3p1:IsForeclosure>true</d3p1:IsForeclosure>
        <d3p1:Pin>sample string 9</d3p1:Pin>
        <d3p1:PropertyClass>sample string 7</d3p1:PropertyClass>
        <d3p1:PurchaseDate>2025-05-20T15:33:21.6430375-05:00</d3p1:PurchaseDate>
        <d3p1:PurchasePrice>1</d3p1:PurchasePrice>
        <d3p1:State>sample string 3</d3p1:State>
        <d3p1:TaxCode>sample string 5</d3p1:TaxCode>
        <d3p1:Township>sample string 6</d3p1:Township>
        <d3p1:ZipCode>sample string 4</d3p1:ZipCode>
      </d3p1:ClientPropertyModel>
    </Properties>
  </BusinessUserClientModel>
</ArrayOfBusinessUserClientModel>