Incentive API Reference
API Reference/Incentive

Incentive

For authentication instructions, see API overview.

Endpoints

get/api/v2/incentive-plans
post/api/v2/incentive-plans
get/api/v2/incentive-plans/:id
put/api/v2/incentive-plans/:id
patch/api/v2/incentive-plans/:id
delete/api/v2/incentive-plans/deleted/:id
get

List all incentive plans

Returns a list of incentive plans. The incentive plans are returned in sorted order, with the most recent appearing first.

Query parameters

  • limitinteger

    The number of records to return

  • pageinteger

    The page number

  • orderstring

    The order of the records

  • sortBystring

    The sort of the records

  • fieldsstring

    The filter of the records

  • pstring

    policyFilters

  • qstring

    search query

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/incentive-plans

Response

No response schema
post

Create incentive plans

Create incentive plans. You need to pass through any required fields, and you can optionally pass through other fields.

Request body

  • planCodestring
  • planNamestring
  • calculationPeriodstring
  • scopestring
  • calculateOnActualAchievementboolean
  • qualifyingMetricsarray

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X POST -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/incentive-plans \
	-d 'planCode="incentive1"' \
	-d 'planName="description1"' \
	-d 'calculationPeriod="Monthly"' \
	-d 'scope="user"' \
	-d 'calculateOnActualAchievement=true' \
	-d 'qualifyingMetrics="array"'

Response

No response schema
get

Retrieve incentive plans

Returns a single incentive plan, which you can request by passing through an id in the url.

Path parameters

  • idstring

    ID of the incentive plan

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/incentive-plans/:id

Response

No response schema
put

Update incentive plans

Path parameters

  • idstring

    ID of the incentive plan

Request body

  • planCodestring
  • planNamestring
  • calculationPeriodstring
  • scopestring
  • calculateOnActualAchievementboolean
  • qualifyingMetricsarray

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X PUT \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/incentive-plans/:id \
	-d 'planCode="incentive1"' \
	-d 'planName="description1"' \
	-d 'calculationPeriod="Monthly"' \
	-d 'scope="user"' \
	-d 'calculateOnActualAchievement=true' \
	-d 'qualifyingMetrics="array"'

Response

No response schema
patch

Update incentive plans soft

Update incentive plans soft by setting the values of the parameters passed. Any parameters not set will be unchanged.

Path parameters

  • idstring

    ID of the incentive plan

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/incentive-plans/:id

Response

No response schema
delete

Delete incentive plans

Path parameters

  • idstring

    ID of the incentive plan

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X DELETE \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/incentive-plans/deleted/:id

Response

No response schema