Skip to main content
GET
/
incentives
/
{incentiveId}
Get an incentive by id
curl --request GET \
  --url https://api.rallyuxr.com/api/public/v1/incentives/{incentiveId} \
  --header 'Authorization: Bearer <token>'
{
  "incentiveId": "<string>",
  "type": "MONEY_OR_GIFT_CARD",
  "amountCents": 123,
  "sentAt": "2023-11-07T05:31:56Z",
  "recipientEmail": "[email protected]",
  "personId": "<string>",
  "participantId": "<string>",
  "studyId": "<string>",
  "status": "UNCLAIMED",
  "budgetId": "<string>",
  "customIncentiveId": "<string>",
  "customIncentiveValue": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
incentiveId
string
required

Response

Incentive response

An incentives's metadata

​
incentiveId
string
required

The ID of the incentive

​
type
enum<string> | null
required

The type of the incentive

Available options:
MONEY_OR_GIFT_CARD,
CUSTOM,
RECRUITMENT_FEE,
RESPONDENT_MONEY
​
amountCents
integer | null
required

The value of the incentive in cents

​
sentAt
string<date-time>
required

When the incentive was sent

​
recipientEmail
string<email> | null
required

The email of the recipient. Masked if the api key doesn't have permissions

​
personId
string | null
required

The ID of the person

​
participantId
string | null
required

The ID of the participant

​
studyId
string | null
required

The ID of the study

​
status
enum<string>
required

The payment status of the incentive. Money and Charity incentives move through UNCLAIMED -> CLAIMED, ERROR, CANCELED. Custom Incentives have no flow and are always SENT

Available options:
UNCLAIMED,
CLAIMED,
CANCELED,
ERROR,
SENT
​
budgetId
string | null
required

The ID of the budget

​
customIncentiveId
string | null

The ID of the custom incentive

​
customIncentiveValue
string | null

The value of the custom incentive