Help Center

Awards

Cloud Pyrus

Methods allow the granting of awards to employees to be automated by tracking achievements using an event counter and setting a threshold, upon exceeding which the award is assigned automatically. For example, the "Journey Begins!" award may be automatically awarded to an employee on their first working day and then automatically revoked after 365 days.

PUT /awards/{id}/threshold

The method sets the threshold for awarding and revoking an award based on its ID. You can pass one or both values. If you need to reset the threshold, set it to 0.

PUT https://api.pyrus.com/v4/awards/{id}/threshold

Request body


{
  "grant_threshold": 1,
  "revoke_threshold": 91
}

Response body


{
  "grant_threshold": 1,
  "revoke_threshold": 91
}

curl

curl -X PUT \
  https://api.pyrus.com/v4/awards/{id}/threshold \
  -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "grant_threshold": 1,
  "revoke_threshold": 91
}'

Parameters

grant_thresholda number, a non-negative integer. The counter value at which the award is awarded. To disable the award threshold, enter 0.
revoke_thresholda number, a non-negative integer. The counter value at which an award is revoked. To disable the revoking threshold, enter 0. If an award threshold is set, the revoking threshold must be greater than this value.

Please note: If an employee's counter already had a certain value before you changed an award threshold, their award status will not be automatically updated. For example, the "Journey Begins!" award is revoked when the counter reaches 365. After changing the revoking threshold to 90, an award will not be revoked immediately, even if the current counter value is already above 90. The revocation will only occur the next time the user counter is updated.

GET /awards/{id}/threshold

The method returns the current values ​​of the triggering and revoking thresholds for an award by its ID.

GET https://api.pyrus.com/v4/awards/{id}/threshold

Response body


{
	"grant_threshold": 0,
    "revoke_threshold": 0
}

curl

curl -X GET \
  https://api.pyrus.com/v4/awards/{id}/threshold \
  -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'

GET /members/{member-id}/awards/{award-id}/counter

The method returns the current value of the award counter for a specific user.

GET https://api.pyrus.com/v4/members/{member-id}/awards/{award-id}/counter

Response body


{
  "person_id": 1248278,
  "award_id": 1324,
  "award_counter": 0,
  "assignment_date": "2025-10-21T14:43:15Z"
}

curl

curl -X GET \
  https://api.pyrus.com/v4/members/{member-id}/awards/{award-id}/award_counter \
  -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'

POST /members/{member-id}/awards/{award-id}/counter/increment

The method increases the counter value by 1. If the threshold is not set, increasing the user's counter will not result in an award being awarded.

POST https://api.pyrus.com/v4/members/{member-id}/awards/{award-id}/counter/increment

Response body

{
    "person_id": 1152811,
    "award_id": 1387,
    "award_counter": 2,
    "assignment_date": "2025-10-28T10:14:30Z"
}

curl


curl -X POST \
  https://api.pyrus.com/v4/members/{member-id}/awards/{award-id}/counter/increment \
  -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'

PUT /members/{member-id}/awards/{award-id}/counter

The method sets a new value for the user's award counter, replacing its current state.

PUT https://api.pyrus.com/v4/members/{member-id}/awards/{award-id}/counter?value={number}

Response body

{
   "person_id": 1248278,
   "award_id": 1324,
   "award_counter": 100,
   "assignment_date": "2025-10-21T14:43:15Z"
}

curl

curl -X PUT \
  https://api.pyrus.com/v4/members/{member-id}/awards/{award-id}/counter?value=number \
  -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'

Parameters

valueNumber. New value of the award counter.

Was this article helpful?