GET
/
incentives
/
custom
/
{customIncentiveId}
Get a custom incentive by id
curl --request GET \
  --url https://api.rallyuxr.com/api/public/v1/incentives/custom/{customIncentiveId} \
  --header 'Authorization: Bearer <token>'
{
  "customIncentiveId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "type": "STRING",
  "options": [
    {
      "name": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

customIncentiveId
string
required

The id of the custom incentive

Response

Custom incentive response

customIncentiveId
string
required

The id of the custom incentive

name
string
required

The name of the custom incentive

description
string | null
required

The description of the custom incentive

type
enum<string>
required

The type of the custom incentive

Available options:
STRING,
NUMBER,
MONETARY,
SINGLE_SELECT
options
object[] | null
required