GET api/users/{userId}/referrals?periodStart={periodStart}&periodEnd={periodEnd}

This method will retrieve client referrals for an individual influencer

Requires Authorization!

Request Information

URI Parameters

Name	Description	Type	Additional information
userId	Id of the individual influencer	integer	Required
periodStart	Period start date [Format:MM/dd/yyyy]	date	Required
periodEnd	Period end date [Format:MM/dd/yyyy]	date	Required

Body Parameters

None.

Response Information

Resource Description

Collection of

Collection of ReferredClientModel

Name	Type	Additional information
UserId	integer	None.
ClientName	string	None.
ClientPhone	string	None.
ClientEmail	string	None.
OrderId	integer	None.
OrderNumber	string	None.
OrderStatus	string	None.
AmountCharged	decimal number	None.
DiscountApplied	decimal number	None.
AmountPaid	decimal number	None.
OrderDate	date	None.
AppealId	integer	None.
AppealNumber	string	None.
AppealStatus	string	None.
AppealedPropertyId	integer	None.
AppealedPropertyAddress	string	None.
AppealedPropertyPin	string	None.
Township	string	None.
AppealDate	date	None.
AttorneyName	string	None.
AttorneyEmail	string	None.
InfluencerUserId	integer	None.
InfluencerName	string	None.
InfluencerDiscount	string	None.
AnalysisDate	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "userId": 1,
    "clientName": "sample string 2",
    "clientPhone": "sample string 3",
    "clientEmail": "sample string 4",
    "orderId": 5,
    "orderNumber": "sample string 6",
    "orderStatus": "sample string 7",
    "amountCharged": 8.0,
    "discountApplied": 9.0,
    "amountPaid": 10.0,
    "orderDate": "2025-05-20T15:37:12.0636231-05:00",
    "appealId": 12,
    "appealNumber": "sample string 13",
    "appealStatus": "sample string 14",
    "appealedPropertyId": 15,
    "appealedPropertyAddress": "sample string 16",
    "appealedPropertyPin": "sample string 17",
    "township": "sample string 18",
    "appealDate": "2025-05-20T15:37:12.0656557-05:00",
    "attorneyName": "sample string 20",
    "attorneyEmail": "sample string 21",
    "influencerUserId": 22,
    "influencerName": "sample string 23",
    "influencerDiscount": "sample string 24",
    "analysisDate": "2025-05-20T15:37:12.0676889-05:00"
  },
  {
    "userId": 1,
    "clientName": "sample string 2",
    "clientPhone": "sample string 3",
    "clientEmail": "sample string 4",
    "orderId": 5,
    "orderNumber": "sample string 6",
    "orderStatus": "sample string 7",
    "amountCharged": 8.0,
    "discountApplied": 9.0,
    "amountPaid": 10.0,
    "orderDate": "2025-05-20T15:37:12.0636231-05:00",
    "appealId": 12,
    "appealNumber": "sample string 13",
    "appealStatus": "sample string 14",
    "appealedPropertyId": 15,
    "appealedPropertyAddress": "sample string 16",
    "appealedPropertyPin": "sample string 17",
    "township": "sample string 18",
    "appealDate": "2025-05-20T15:37:12.0656557-05:00",
    "attorneyName": "sample string 20",
    "attorneyEmail": "sample string 21",
    "influencerUserId": 22,
    "influencerName": "sample string 23",
    "influencerDiscount": "sample string 24",
    "analysisDate": "2025-05-20T15:37:12.0676889-05:00"
  }
]

text/html

Sample:

[{"userId":1,"clientName":"sample string 2","clientPhone":"sample string 3","clientEmail":"sample string 4","orderId":5,"orderNumber":"sample string 6","orderStatus":"sample string 7","amountCharged":8.0,"discountApplied":9.0,"amountPaid":10.0,"orderDate":"2025-05-20T15:37:12.0636231-05:00","appealId":12,"appealNumber":"sample string 13","appealStatus":"sample string 14","appealedPropertyId":15,"appealedPropertyAddress":"sample string 16","appealedPropertyPin":"sample string 17","township":"sample string 18","appealDate":"2025-05-20T15:37:12.0656557-05:00","attorneyName":"sample string 20","attorneyEmail":"sample string 21","influencerUserId":22,"influencerName":"sample string 23","influencerDiscount":"sample string 24","analysisDate":"2025-05-20T15:37:12.0676889-05:00"},{"userId":1,"clientName":"sample string 2","clientPhone":"sample string 3","clientEmail":"sample string 4","orderId":5,"orderNumber":"sample string 6","orderStatus":"sample string 7","amountCharged":8.0,"discountApplied":9.0,"amountPaid":10.0,"orderDate":"2025-05-20T15:37:12.0636231-05:00","appealId":12,"appealNumber":"sample string 13","appealStatus":"sample string 14","appealedPropertyId":15,"appealedPropertyAddress":"sample string 16","appealedPropertyPin":"sample string 17","township":"sample string 18","appealDate":"2025-05-20T15:37:12.0656557-05:00","attorneyName":"sample string 20","attorneyEmail":"sample string 21","influencerUserId":22,"influencerName":"sample string 23","influencerDiscount":"sample string 24","analysisDate":"2025-05-20T15:37:12.0676889-05:00"}]

application/xml, text/xml

Sample:

<ArrayOfReferredClientModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.ReferrerBinding">
  <ReferredClientModel>
    <AmountCharged>8</AmountCharged>
    <AmountPaid>10</AmountPaid>
    <AnalysisDate>2025-05-20T15:37:12.0676889-05:00</AnalysisDate>
    <AppealDate>2025-05-20T15:37:12.0656557-05:00</AppealDate>
    <AppealId>12</AppealId>
    <AppealNumber>sample string 13</AppealNumber>
    <AppealStatus>sample string 14</AppealStatus>
    <AppealedPropertyAddress>sample string 16</AppealedPropertyAddress>
    <AppealedPropertyId>15</AppealedPropertyId>
    <AppealedPropertyPin>sample string 17</AppealedPropertyPin>
    <AttorneyEmail>sample string 21</AttorneyEmail>
    <AttorneyName>sample string 20</AttorneyName>
    <ClientEmail>sample string 4</ClientEmail>
    <ClientName>sample string 2</ClientName>
    <ClientPhone>sample string 3</ClientPhone>
    <DiscountApplied>9</DiscountApplied>
    <InfluencerDiscount>sample string 24</InfluencerDiscount>
    <InfluencerName>sample string 23</InfluencerName>
    <InfluencerUserId>22</InfluencerUserId>
    <OrderDate>2025-05-20T15:37:12.0636231-05:00</OrderDate>
    <OrderId>5</OrderId>
    <OrderNumber>sample string 6</OrderNumber>
    <OrderStatus>sample string 7</OrderStatus>
    <Township>sample string 18</Township>
    <UserId>1</UserId>
  </ReferredClientModel>
  <ReferredClientModel>
    <AmountCharged>8</AmountCharged>
    <AmountPaid>10</AmountPaid>
    <AnalysisDate>2025-05-20T15:37:12.0676889-05:00</AnalysisDate>
    <AppealDate>2025-05-20T15:37:12.0656557-05:00</AppealDate>
    <AppealId>12</AppealId>
    <AppealNumber>sample string 13</AppealNumber>
    <AppealStatus>sample string 14</AppealStatus>
    <AppealedPropertyAddress>sample string 16</AppealedPropertyAddress>
    <AppealedPropertyId>15</AppealedPropertyId>
    <AppealedPropertyPin>sample string 17</AppealedPropertyPin>
    <AttorneyEmail>sample string 21</AttorneyEmail>
    <AttorneyName>sample string 20</AttorneyName>
    <ClientEmail>sample string 4</ClientEmail>
    <ClientName>sample string 2</ClientName>
    <ClientPhone>sample string 3</ClientPhone>
    <DiscountApplied>9</DiscountApplied>
    <InfluencerDiscount>sample string 24</InfluencerDiscount>
    <InfluencerName>sample string 23</InfluencerName>
    <InfluencerUserId>22</InfluencerUserId>
    <OrderDate>2025-05-20T15:37:12.0636231-05:00</OrderDate>
    <OrderId>5</OrderId>
    <OrderNumber>sample string 6</OrderNumber>
    <OrderStatus>sample string 7</OrderStatus>
    <Township>sample string 18</Township>
    <UserId>1</UserId>
  </ReferredClientModel>
</ArrayOfReferredClientModel>