GET
/
incentives
/
custom
curl --request GET \
  --url https://api.rallyuxr.com/api/public/v1/incentives/custom \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "customIncentiveId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "type": "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.

Query Parameters

​
startCursor
string

The cursor to start from

​
size
number
default:
10

The number of items to return

Required range: 0 < x < 100

Response

200
application/json
Custom incentive search response
​
results
object[]
required
​
total
number
required

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

Required range: x > 0
​
pageInfo
object
required

Information about the current page

Get paginated list of incentivesGet a custom incentive by id