Get paginated list of incentives
Gets all incentives in your workspace
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
Search parameters to get incentives within your workspace
The ID of the study
Filter option to search for people
A custom property filter
BOOLEAN CUSTOM_PROPERTY EQUAL, NOT_EQUAL {
"propertyType": "STRING",
"propertyGroup": "CUSTOM_PROPERTY",
"propertyName": "CUSTOM_PROPERTY",
"propertyId": "custom_property_1",
"operator": "IS",
"value": "some value"
}
AND, OR Pagination arguments. Use startCursor from the result of the endCursor of the response to get the next page. Pagination in reverse is not currently supported
Response
An incentives's metadata
The ID of the incentive
The type of the incentive
MONEY_OR_GIFT_CARD, CUSTOM, RECRUITMENT_FEE, RESPONDENT_MONEY The value of the incentive in cents
x > 0When the incentive was sent
The email of the recipient. Masked if the api key doesn't have permissions
The ID of the person
The ID of the participant
The ID of the study
The payment status of the incentive
ERROR, PENDING, SENT, UNCLAIMED, CLAIMED, CANCELED The ID of the budget
The ID of the custom incentive
The value of the custom incentive
The total number of items in your workspaces based on your search parameters
x > 0Information about the current page
Whether there are additional pages of results
Whether there is a prior page of results
The start of the current page of results
The end of the current page of results. Use to fetch the next page
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>"
}
}