GET api/rewards

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

Request Information

URI Parameters

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

NameDescriptionTypeAdditional information
programId

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

 string

None.
memberId

ID of the member. Optional.

 globally unique identifier

None.
query

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

 string

None.
status

If specified, the rewards must be in this status. Accepted values are 'Pending', 'Processing', and 'Issued'. Optional

 string

None.
sort

Column to sort by. Accepted values: Create_Dt_Asc , Create_Dt_Desc , Reward_Action_Desc, Reward_Action_Asc, Recipient_Name_Desc, Recipient_Name_Asc, Complete_Dt_Desc, Complete_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.
offset

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

 integer

Default value is 0
count

Count of referrals rewards. Optional.

 integer

Default value is 2147483647

Body Parameters

None.

Response Information

Resource Description

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

Type: RewardSet

NameDescriptionTypeAdditional information
rewards

Collection of Reward

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",
  "rewards": [
    {
      "id": "f49df57b-3afa-4195-9da5-a70362717736",
      "payoutId": "0beff06d-621d-4e07-b837-7708f04568aa",
      "payoutDescription": "sample string 3",
      "programId": "568aa047-b0b3-4b83-8869-a759c850dd32",
      "programName": "sample string 5",
      "memberId": "19362e25-586b-4ca7-8044-de5d27a18147",
      "referralId": "166ffc55-a191-48ff-9786-610d371bd073",
      "type": "sample string 6",
      "recipientId": "3f417b49-ad29-4ff3-890c-15124eabf42f",
      "recipientName": "sample string 7",
      "recipientEmailAddress": "sample string 8",
      "recipientExternalIdentifier": "sample string 9",
      "externalIdentifier": "sample string 10",
      "status": "sample string 11",
      "amount": 12.0,
      "createDate": "2025-07-12T21:07:54.3201382Z",
      "issueDate": "2025-07-12T21:07:54.3201382Z",
      "eligibilityDate": "2025-07-12T21:07:54.3201382Z",
      "description": "sample string 15",
      "transactionID": "93d37c6d-5c7f-4d2a-b438-40a3893e3b36",
      "updateDate": "2025-07-12T21:07:54.3201382Z",
      "referralDisplayName": "sample string 17",
      "currencyCode": "sample string 18",
      "source": "sample string 19",
      "programRewardRuleId": "598cad17-783e-4d19-a495-9d3ba9d77313",
      "paymentType": "sample string 20",
      "paymentCode": "sample string 21",
      "completeNote": "sample string 22"
    },
    {
      "id": "f49df57b-3afa-4195-9da5-a70362717736",
      "payoutId": "0beff06d-621d-4e07-b837-7708f04568aa",
      "payoutDescription": "sample string 3",
      "programId": "568aa047-b0b3-4b83-8869-a759c850dd32",
      "programName": "sample string 5",
      "memberId": "19362e25-586b-4ca7-8044-de5d27a18147",
      "referralId": "166ffc55-a191-48ff-9786-610d371bd073",
      "type": "sample string 6",
      "recipientId": "3f417b49-ad29-4ff3-890c-15124eabf42f",
      "recipientName": "sample string 7",
      "recipientEmailAddress": "sample string 8",
      "recipientExternalIdentifier": "sample string 9",
      "externalIdentifier": "sample string 10",
      "status": "sample string 11",
      "amount": 12.0,
      "createDate": "2025-07-12T21:07:54.3201382Z",
      "issueDate": "2025-07-12T21:07:54.3201382Z",
      "eligibilityDate": "2025-07-12T21:07:54.3201382Z",
      "description": "sample string 15",
      "transactionID": "93d37c6d-5c7f-4d2a-b438-40a3893e3b36",
      "updateDate": "2025-07-12T21:07:54.3201382Z",
      "referralDisplayName": "sample string 17",
      "currencyCode": "sample string 18",
      "source": "sample string 19",
      "programRewardRuleId": "598cad17-783e-4d19-a495-9d3ba9d77313",
      "paymentType": "sample string 20",
      "paymentCode": "sample string 21",
      "completeNote": "sample string 22"
    }
  ]
}

application/xml, text/xml

Sample: 
<RewardSet xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <offset>1</offset>
  <total>2</total>
  <message>sample string 3</message>
  <rewards>
    <reward>
      <id>f49df57b-3afa-4195-9da5-a70362717736</id>
      <payoutId>0beff06d-621d-4e07-b837-7708f04568aa</payoutId>
      <payoutDescription>sample string 3</payoutDescription>
      <programId>568aa047-b0b3-4b83-8869-a759c850dd32</programId>
      <programName>sample string 5</programName>
      <memberId>19362e25-586b-4ca7-8044-de5d27a18147</memberId>
      <referralId>166ffc55-a191-48ff-9786-610d371bd073</referralId>
      <type>sample string 6</type>
      <recipientId>3f417b49-ad29-4ff3-890c-15124eabf42f</recipientId>
      <recipientName>sample string 7</recipientName>
      <recipientEmailAddress>sample string 8</recipientEmailAddress>
      <recipientExternalIdentifier>sample string 9</recipientExternalIdentifier>
      <externalIdentifier>sample string 10</externalIdentifier>
      <status>sample string 11</status>
      <amount>12</amount>
      <createDate>2025-07-12T21:07:54.3201382+00:00</createDate>
      <issueDate>2025-07-12T21:07:54.3201382+00:00</issueDate>
      <eligibilityDate>2025-07-12T21:07:54.3201382+00:00</eligibilityDate>
      <description>sample string 15</description>
      <transactionID>93d37c6d-5c7f-4d2a-b438-40a3893e3b36</transactionID>
      <updateDate>2025-07-12T21:07:54.3201382+00:00</updateDate>
      <referralDisplayName>sample string 17</referralDisplayName>
      <currencyCode>sample string 18</currencyCode>
      <source>sample string 19</source>
      <programRewardRuleId>598cad17-783e-4d19-a495-9d3ba9d77313</programRewardRuleId>
      <paymentType>sample string 20</paymentType>
      <paymentCode>sample string 21</paymentCode>
      <completeNote>sample string 22</completeNote>
    </reward>
    <reward>
      <id>f49df57b-3afa-4195-9da5-a70362717736</id>
      <payoutId>0beff06d-621d-4e07-b837-7708f04568aa</payoutId>
      <payoutDescription>sample string 3</payoutDescription>
      <programId>568aa047-b0b3-4b83-8869-a759c850dd32</programId>
      <programName>sample string 5</programName>
      <memberId>19362e25-586b-4ca7-8044-de5d27a18147</memberId>
      <referralId>166ffc55-a191-48ff-9786-610d371bd073</referralId>
      <type>sample string 6</type>
      <recipientId>3f417b49-ad29-4ff3-890c-15124eabf42f</recipientId>
      <recipientName>sample string 7</recipientName>
      <recipientEmailAddress>sample string 8</recipientEmailAddress>
      <recipientExternalIdentifier>sample string 9</recipientExternalIdentifier>
      <externalIdentifier>sample string 10</externalIdentifier>
      <status>sample string 11</status>
      <amount>12</amount>
      <createDate>2025-07-12T21:07:54.3201382+00:00</createDate>
      <issueDate>2025-07-12T21:07:54.3201382+00:00</issueDate>
      <eligibilityDate>2025-07-12T21:07:54.3201382+00:00</eligibilityDate>
      <description>sample string 15</description>
      <transactionID>93d37c6d-5c7f-4d2a-b438-40a3893e3b36</transactionID>
      <updateDate>2025-07-12T21:07:54.3201382+00:00</updateDate>
      <referralDisplayName>sample string 17</referralDisplayName>
      <currencyCode>sample string 18</currencyCode>
      <source>sample string 19</source>
      <programRewardRuleId>598cad17-783e-4d19-a495-9d3ba9d77313</programRewardRuleId>
      <paymentType>sample string 20</paymentType>
      <paymentCode>sample string 21</paymentCode>
      <completeNote>sample string 22</completeNote>
    </reward>
  </rewards>
</RewardSet>