GET api/referrals

Get a list of referrals ordered by create date. The list can be filtered by program. The offset and count parameters can be used to specify the set of referrals.

Request Information

URI Parameters

Query String: programId={programId}&query={query}&memberId={memberId}&sort={sort}&dateFrom={dateFrom}&dateTo={dateTo}&status={status}&offset={offset}&count={count}

NameDescriptionTypeAdditional information
programId

ID of the program, program name, or program title. Optional.

string

None.

query

If specified, a referral must have this value as its email address, id, or external id. You can also query by member referral code. Optional.

string

None.

memberId

Filter by Member Id. Optional.

string

None.

sort

Column to sort by. Accepted values: Create_Dt_Desc , Create_Dt_Asc , Amount_Desc, Amount_Asc, Qualified_Dt_Desc, Qualified_Dt_Asc, Closed_Dt_Desc, Closed_Dt_Asc. Optional.

string

Default value is Create_Dt_Desc

dateFrom

Show all members created after this date. Optional.

date

None.

dateTo

Show all members created before this date. Optional.

date

None.

status

Use this field to filter the referrals down to those of a desired status. The value can be "pending", "qualified", "approved", "denied". Optional.

string

None.

offset

Starting index (0 based) of the referrals. Optional.

integer

Default value is 0

count

Count of referrals returned. Optional.

integer

Default value is 2147483647

Body Parameters

None.

Response Information

Resource Description

[HTTP Status 200 - OK] A set of referrals.

Type: ReferralSet

NameDescriptionTypeAdditional information
referrals

Collection of Referral

None.

offset

Starting index (0 based) of the elements in the set.

integer

None.

total

Total number of elements in the set.

integer

None.

message

The message provides more information about the results of the client's request. Review this field for error information.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "offset": 1,
  "total": 2,
  "message": "sample string 3",
  "referrals": [
    {
      "id": "9e7cd508-1d02-4ed5-a460-33f38402dade",
      "displayName": "sample string 2",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "fullName": "sample string 5",
      "email": "sample string 6",
      "externalIdentifier": "sample string 7",
      "phoneNumber": "sample string 8",
      "amount": 9.0,
      "amountFormatted": "sample string 10",
      "preferredContact": "sample string 11",
      "createDate": "2018-07-19T13:40:45.876473Z",
      "updateDate": "2018-07-19T13:40:45.876473Z",
      "source": "sample string 14",
      "programId": "e6ad01b9-4754-46ca-a8d9-b8b7c55edd82",
      "programName": "sample string 16",
      "programTitle": "sample string 17",
      "referringMemberId": "14f96d5d-a2fc-480c-b01b-f94e7fc84c90",
      "referringMemberName": "sample string 19",
      "memberEmail": "sample string 20",
      "memberReferralCode": "sample string 21",
      "memberExternalIdentifier": "sample string 22",
      "approvedDate": "2018-07-19T13:40:45.876473Z",
      "qualifiedDate": "2018-07-19T13:40:45.876473Z",
      "status": "sample string 23",
      "companyName": "sample string 24",
      "note": "sample string 25",
      "publicNote": "sample string 26",
      "customOption1Name": "sample string 27",
      "customOption2Name": "sample string 28",
      "customText1Name": "sample string 29",
      "customText2Name": "sample string 30",
      "customText3Name": "sample string 31",
      "customOption1Value": "sample string 32",
      "customOption2Value": "sample string 33",
      "customText1Value": "sample string 34",
      "customText2Value": "sample string 35",
      "customText3Value": "sample string 36",
      "conversionNote": "sample string 37",
      "conversionIPAddress": "sample string 38",
      "utmSource": "sample string 39",
      "utmMedium": "sample string 40",
      "utmCampaign": "sample string 41",
      "browserReferrerUrl": "sample string 42",
      "IPAddressSource": "sample string 43"
    },
    {
      "id": "9e7cd508-1d02-4ed5-a460-33f38402dade",
      "displayName": "sample string 2",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "fullName": "sample string 5",
      "email": "sample string 6",
      "externalIdentifier": "sample string 7",
      "phoneNumber": "sample string 8",
      "amount": 9.0,
      "amountFormatted": "sample string 10",
      "preferredContact": "sample string 11",
      "createDate": "2018-07-19T13:40:45.876473Z",
      "updateDate": "2018-07-19T13:40:45.876473Z",
      "source": "sample string 14",
      "programId": "e6ad01b9-4754-46ca-a8d9-b8b7c55edd82",
      "programName": "sample string 16",
      "programTitle": "sample string 17",
      "referringMemberId": "14f96d5d-a2fc-480c-b01b-f94e7fc84c90",
      "referringMemberName": "sample string 19",
      "memberEmail": "sample string 20",
      "memberReferralCode": "sample string 21",
      "memberExternalIdentifier": "sample string 22",
      "approvedDate": "2018-07-19T13:40:45.876473Z",
      "qualifiedDate": "2018-07-19T13:40:45.876473Z",
      "status": "sample string 23",
      "companyName": "sample string 24",
      "note": "sample string 25",
      "publicNote": "sample string 26",
      "customOption1Name": "sample string 27",
      "customOption2Name": "sample string 28",
      "customText1Name": "sample string 29",
      "customText2Name": "sample string 30",
      "customText3Name": "sample string 31",
      "customOption1Value": "sample string 32",
      "customOption2Value": "sample string 33",
      "customText1Value": "sample string 34",
      "customText2Value": "sample string 35",
      "customText3Value": "sample string 36",
      "conversionNote": "sample string 37",
      "conversionIPAddress": "sample string 38",
      "utmSource": "sample string 39",
      "utmMedium": "sample string 40",
      "utmCampaign": "sample string 41",
      "browserReferrerUrl": "sample string 42",
      "IPAddressSource": "sample string 43"
    }
  ]
}

application/xml, text/xml

Sample:
<ReferralSet xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <offset>1</offset>
  <total>2</total>
  <message>sample string 3</message>
  <referrals>
    <referral>
      <id>9e7cd508-1d02-4ed5-a460-33f38402dade</id>
      <displayName>sample string 2</displayName>
      <firstName>sample string 3</firstName>
      <lastName>sample string 4</lastName>
      <fullName>sample string 5</fullName>
      <email>sample string 6</email>
      <externalIdentifier>sample string 7</externalIdentifier>
      <phoneNumber>sample string 8</phoneNumber>
      <amount>9</amount>
      <amountFormatted>sample string 10</amountFormatted>
      <createDate>2018-07-19T09:40:45.876473-04:00</createDate>
      <preferredContact>sample string 11</preferredContact>
      <updateDate>2018-07-19T09:40:45.876473-04:00</updateDate>
      <source>sample string 14</source>
      <programId>e6ad01b9-4754-46ca-a8d9-b8b7c55edd82</programId>
      <programName>sample string 16</programName>
      <programTitle>sample string 17</programTitle>
      <referringMemberId>14f96d5d-a2fc-480c-b01b-f94e7fc84c90</referringMemberId>
      <referringMemberName>sample string 19</referringMemberName>
      <memberEmail>sample string 20</memberEmail>
      <memberReferralCode>sample string 21</memberReferralCode>
      <memberExternalIdentifier>sample string 22</memberExternalIdentifier>
      <approvedDate>2018-07-19T09:40:45.876473-04:00</approvedDate>
      <qualifiedDate>2018-07-19T09:40:45.876473-04:00</qualifiedDate>
      <status>sample string 23</status>
      <companyName>sample string 24</companyName>
      <note>sample string 25</note>
      <publicNote>sample string 26</publicNote>
      <customOption1Name>sample string 27</customOption1Name>
      <customOption2Name>sample string 28</customOption2Name>
      <customText1Name>sample string 29</customText1Name>
      <customText2Name>sample string 30</customText2Name>
      <customText3Name>sample string 31</customText3Name>
      <customOption1Value>sample string 32</customOption1Value>
      <customOption2Value>sample string 33</customOption2Value>
      <customText1Value>sample string 34</customText1Value>
      <customText2Value>sample string 35</customText2Value>
      <customText3Value>sample string 36</customText3Value>
      <conversionNote>sample string 37</conversionNote>
      <conversionIPAddress>sample string 38</conversionIPAddress>
      <utmSource>sample string 39</utmSource>
      <utmMedium>sample string 40</utmMedium>
      <utmCampaign>sample string 41</utmCampaign>
      <browserReferrerUrl>sample string 42</browserReferrerUrl>
      <IPAddressSource>sample string 43</IPAddressSource>
    </referral>
    <referral>
      <id>9e7cd508-1d02-4ed5-a460-33f38402dade</id>
      <displayName>sample string 2</displayName>
      <firstName>sample string 3</firstName>
      <lastName>sample string 4</lastName>
      <fullName>sample string 5</fullName>
      <email>sample string 6</email>
      <externalIdentifier>sample string 7</externalIdentifier>
      <phoneNumber>sample string 8</phoneNumber>
      <amount>9</amount>
      <amountFormatted>sample string 10</amountFormatted>
      <createDate>2018-07-19T09:40:45.876473-04:00</createDate>
      <preferredContact>sample string 11</preferredContact>
      <updateDate>2018-07-19T09:40:45.876473-04:00</updateDate>
      <source>sample string 14</source>
      <programId>e6ad01b9-4754-46ca-a8d9-b8b7c55edd82</programId>
      <programName>sample string 16</programName>
      <programTitle>sample string 17</programTitle>
      <referringMemberId>14f96d5d-a2fc-480c-b01b-f94e7fc84c90</referringMemberId>
      <referringMemberName>sample string 19</referringMemberName>
      <memberEmail>sample string 20</memberEmail>
      <memberReferralCode>sample string 21</memberReferralCode>
      <memberExternalIdentifier>sample string 22</memberExternalIdentifier>
      <approvedDate>2018-07-19T09:40:45.876473-04:00</approvedDate>
      <qualifiedDate>2018-07-19T09:40:45.876473-04:00</qualifiedDate>
      <status>sample string 23</status>
      <companyName>sample string 24</companyName>
      <note>sample string 25</note>
      <publicNote>sample string 26</publicNote>
      <customOption1Name>sample string 27</customOption1Name>
      <customOption2Name>sample string 28</customOption2Name>
      <customText1Name>sample string 29</customText1Name>
      <customText2Name>sample string 30</customText2Name>
      <customText3Name>sample string 31</customText3Name>
      <customOption1Value>sample string 32</customOption1Value>
      <customOption2Value>sample string 33</customOption2Value>
      <customText1Value>sample string 34</customText1Value>
      <customText2Value>sample string 35</customText2Value>
      <customText3Value>sample string 36</customText3Value>
      <conversionNote>sample string 37</conversionNote>
      <conversionIPAddress>sample string 38</conversionIPAddress>
      <utmSource>sample string 39</utmSource>
      <utmMedium>sample string 40</utmMedium>
      <utmCampaign>sample string 41</utmCampaign>
      <browserReferrerUrl>sample string 42</browserReferrerUrl>
      <IPAddressSource>sample string 43</IPAddressSource>
    </referral>
  </referrals>
</ReferralSet>