Incentives
Get paginated list of incentives
Gets all incentives in your workspace
POST
/
incentives
/
search
curl --request POST \
--url https://api.rallyuxr.com/api/public/v1/incentives/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"studyId": "<string>",
"filter": {
"operator": "AND",
"filters": [
{
"customProperty": {
"propertyType": "STRING",
"propertyGroup": "CUSTOM_PROPERTY",
"propertyName": "CUSTOM_PROPERTY",
"propertyId": "custom_property_1",
"operator": "IS",
"value": "some value"
}
}
]
},
"pageInfo": {
"size": 10
}
}'
{
"results": [
{
"incentiveId": "<string>",
"type": "MONEY_OR_GIFT_CARD",
"amountCents": 123,
"sentAt": "2023-11-07T05:31:56Z",
"recipientEmail": "jsmith@example.com",
"personId": "<string>",
"participantId": "<string>",
"studyId": "<string>",
"status": "ERROR",
"budgetId": "<string>",
"customIncentiveId": "<string>",
"customIncentiveValue": "<string>"
}
],
"total": 123,
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "<string>",
"endCursor": "<string>"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Search parameters to get incentives within your workspace
Response
200
application/json
Incentive search response
The response is of type object
.
curl --request POST \
--url https://api.rallyuxr.com/api/public/v1/incentives/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"studyId": "<string>",
"filter": {
"operator": "AND",
"filters": [
{
"customProperty": {
"propertyType": "STRING",
"propertyGroup": "CUSTOM_PROPERTY",
"propertyName": "CUSTOM_PROPERTY",
"propertyId": "custom_property_1",
"operator": "IS",
"value": "some value"
}
}
]
},
"pageInfo": {
"size": 10
}
}'
{
"results": [
{
"incentiveId": "<string>",
"type": "MONEY_OR_GIFT_CARD",
"amountCents": 123,
"sentAt": "2023-11-07T05:31:56Z",
"recipientEmail": "jsmith@example.com",
"personId": "<string>",
"participantId": "<string>",
"studyId": "<string>",
"status": "ERROR",
"budgetId": "<string>",
"customIncentiveId": "<string>",
"customIncentiveValue": "<string>"
}
],
"total": 123,
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "<string>",
"endCursor": "<string>"
}
}