Skip to main content
POST
/
incentives
/
search
Get paginated list of incentives
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": {
    "filters": [
      {
        "customProperty": {
          "propertyType": "STRING",
          "propertyGroup": "CUSTOM_PROPERTY",
          "propertyName": "CUSTOM_PROPERTY",
          "propertyId": "custom_property_1",
          "operator": "IS",
          "value": "some value"
        }
      }
    ],
    "operator": "AND",
    "sort": {
      "operator": "ASC",
      "propertyGroup": "PERSON",
      "propertyName": "PERSON_ID"
    }
  },
  "pageInfo": {
    "size": 10
  }
}
'
{
  "results": [
    {
      "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>"
    }
  ],
  "total": 123,
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "<string>",
    "endCursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

​
studyId
string

The ID of the study

​
filter
object

Filter option to search for people

​
pageInfo
object

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

Example:
{ "size": 10 }

Response

Incentive search response

​
results
object[]
required
​
total
number
required

The total number of items in your workspaces based on your search parameters

​
pageInfo
object
required

Information about the current page