GET api/referral/getsingle

Get a single Referral

Request Information

URI Parameters

Query String: referralQuery={referralQuery}

NameDescriptionTypeAdditional information
referralQuery

Referral Query. Check by ReferralID, email address or External Id. Required.

string

Default value is

Body Parameters

None.

Response Information

Resource Description

[HTTP Status 200 - OK] A single Referral.

Type: Referral

NameDescriptionTypeAdditional information
id

The unique ID of the referral.

globally unique identifier

None.

displayName

Referral's Display Name

string

None.

firstName

Referral first name

string

None.

lastName

Referral last name

string

None.

fullName

string

None.

email

Referral email address

string

None.

externalIdentifier

An alternative ID provided to help link the member to relevant data in external systems.

string

None.

phoneNumber

string

None.

amount

decimal number

None.

amountFormatted

string

None.

preferredContact

The preferred means to contact the referral. The values an be 'email', 'callMorning', 'callAfternoon', or 'callEvening'.

string

None.

createDate

date

None.

updateDate

date

None.

source

string

None.

programId

The unique ID of the referral program that the referral responded to.

globally unique identifier

None.

programName

string

None.

programTitle

string

None.

referringMemberId

The unique ID of the member that made the referral.

globally unique identifier

None.

referringMemberName

The name of the member that made the referral.

string

None.

memberEmail

string

None.

memberReferralCode

string

None.

memberExternalIdentifier

string

None.

approvedDate

date

None.

qualifiedDate

date

None.

status

The value can be "pending", "qualified", "approved", "denied".

string

None.

companyName

string

None.

note

string

None.

publicNote

string

None.

customOption1Name

string

None.

customOption2Name

string

None.

customText1Name

string

None.

customText2Name

string

None.

customText3Name

string

None.

customOption1Value

string

None.

customOption2Value

string

None.

customText1Value

string

None.

customText2Value

string

None.

customText3Value

string

None.

conversionNote

string

None.

conversionIPAddress

string

None.

utmSource

string

None.

utmMedium

string

None.

utmCampaign

string

None.

browserReferrerUrl

string

None.

IPAddressSource

string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": "c4a84cfb-fb87-4a5d-8f54-54a7ba8449f1",
  "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-10-18T17:41:28.5516814Z",
  "updateDate": "2018-10-18T17:41:28.5516814Z",
  "source": "sample string 14",
  "programId": "146e1705-189a-4998-a13c-caeadaa655bd",
  "programName": "sample string 16",
  "programTitle": "sample string 17",
  "referringMemberId": "87881686-094b-4779-b3bc-2c409e2ac8f6",
  "referringMemberName": "sample string 19",
  "memberEmail": "sample string 20",
  "memberReferralCode": "sample string 21",
  "memberExternalIdentifier": "sample string 22",
  "approvedDate": "2018-10-18T17:41:28.5516814Z",
  "qualifiedDate": "2018-10-18T17:41:28.5516814Z",
  "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:
<referral xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <id>c4a84cfb-fb87-4a5d-8f54-54a7ba8449f1</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-10-18T13:41:28.5516814-04:00</createDate>
  <preferredContact>sample string 11</preferredContact>
  <updateDate>2018-10-18T13:41:28.5516814-04:00</updateDate>
  <source>sample string 14</source>
  <programId>146e1705-189a-4998-a13c-caeadaa655bd</programId>
  <programName>sample string 16</programName>
  <programTitle>sample string 17</programTitle>
  <referringMemberId>87881686-094b-4779-b3bc-2c409e2ac8f6</referringMemberId>
  <referringMemberName>sample string 19</referringMemberName>
  <memberEmail>sample string 20</memberEmail>
  <memberReferralCode>sample string 21</memberReferralCode>
  <memberExternalIdentifier>sample string 22</memberExternalIdentifier>
  <approvedDate>2018-10-18T13:41:28.5516814-04:00</approvedDate>
  <qualifiedDate>2018-10-18T13:41:28.5516814-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>