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}&status={status}&offset={offset}&count={count}

NameDescriptionTypeAdditional information
programId

ID of the program. 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, program id, program name, or program title. Optional.

string

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": "baabfe51-d5d1-42b2-bd5b-269ef26a0afa",
      "firstName": "sample string 2",
      "lastName": "sample string 3",
      "email": "sample string 4",
      "externalIdentifier": "sample string 5",
      "phoneNumber": "sample string 6",
      "amount": 7.0,
      "preferredContact": "sample string 8",
      "createDate": "2018-01-23T01:31:20.8767617Z",
      "programId": "6aacd27c-7e88-4a2e-919c-aab2dc11b341",
      "programName": "sample string 11",
      "programTitle": "sample string 12",
      "referringMemberId": "0e027ace-4714-4c95-adaf-049909739a74",
      "referringMemberName": "sample string 14",
      "approvedDate": "2018-01-23T01:31:20.8767617Z",
      "qualifiedDate": "2018-01-23T01:31:20.8767617Z",
      "status": "sample string 15",
      "companyName": "sample string 16"
    },
    {
      "id": "baabfe51-d5d1-42b2-bd5b-269ef26a0afa",
      "firstName": "sample string 2",
      "lastName": "sample string 3",
      "email": "sample string 4",
      "externalIdentifier": "sample string 5",
      "phoneNumber": "sample string 6",
      "amount": 7.0,
      "preferredContact": "sample string 8",
      "createDate": "2018-01-23T01:31:20.8767617Z",
      "programId": "6aacd27c-7e88-4a2e-919c-aab2dc11b341",
      "programName": "sample string 11",
      "programTitle": "sample string 12",
      "referringMemberId": "0e027ace-4714-4c95-adaf-049909739a74",
      "referringMemberName": "sample string 14",
      "approvedDate": "2018-01-23T01:31:20.8767617Z",
      "qualifiedDate": "2018-01-23T01:31:20.8767617Z",
      "status": "sample string 15",
      "companyName": "sample string 16"
    }
  ]
}

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>baabfe51-d5d1-42b2-bd5b-269ef26a0afa</id>
      <firstName>sample string 2</firstName>
      <lastName>sample string 3</lastName>
      <email>sample string 4</email>
      <externalIdentifier>sample string 5</externalIdentifier>
      <phoneNumber>sample string 6</phoneNumber>
      <amount>7</amount>
      <preferredContact>sample string 8</preferredContact>
      <createDate>2018-01-22T20:31:20.8767617-05:00</createDate>
      <programId>6aacd27c-7e88-4a2e-919c-aab2dc11b341</programId>
      <programName>sample string 11</programName>
      <programTitle>sample string 12</programTitle>
      <referringMemberId>0e027ace-4714-4c95-adaf-049909739a74</referringMemberId>
      <referringMemberName>sample string 14</referringMemberName>
      <approvedDate>2018-01-22T20:31:20.8767617-05:00</approvedDate>
      <qualifiedDate>2018-01-22T20:31:20.8767617-05:00</qualifiedDate>
      <status>sample string 15</status>
      <companyName>sample string 16</companyName>
    </referral>
    <referral>
      <id>baabfe51-d5d1-42b2-bd5b-269ef26a0afa</id>
      <firstName>sample string 2</firstName>
      <lastName>sample string 3</lastName>
      <email>sample string 4</email>
      <externalIdentifier>sample string 5</externalIdentifier>
      <phoneNumber>sample string 6</phoneNumber>
      <amount>7</amount>
      <preferredContact>sample string 8</preferredContact>
      <createDate>2018-01-22T20:31:20.8767617-05:00</createDate>
      <programId>6aacd27c-7e88-4a2e-919c-aab2dc11b341</programId>
      <programName>sample string 11</programName>
      <programTitle>sample string 12</programTitle>
      <referringMemberId>0e027ace-4714-4c95-adaf-049909739a74</referringMemberId>
      <referringMemberName>sample string 14</referringMemberName>
      <approvedDate>2018-01-22T20:31:20.8767617-05:00</approvedDate>
      <qualifiedDate>2018-01-22T20:31:20.8767617-05:00</qualifiedDate>
      <status>sample string 15</status>
      <companyName>sample string 16</companyName>
    </referral>
  </referrals>
</ReferralSet>