Achievers for Developers

API Changelog

As Achievers continues to develop the current version of our API, we will announce changes on this page. Unless stated otherwise, all changes are backwards compatible (e.g. new endpoint, new optional request parameter). We avoid making backwards incompatible changes whenever possible and make every effort to communicate these changes to our customers and partners before they are released.

Suggest Edits

February 20, 2019

Security changes to Achievements API:

  • When a request is made to POST /achievements with a user token, the token owner will be set as the creator of the resulting Achievement; if a creator is specified in the request, the parameter will be ignored
  • When a request is made to POST /achievements with a system token, the creator specified in the request will be set as the creator of the resulting Achievement; if a creator is not specified, the name of the integration will be set as the creator (the integration name is defined by a program administrator within the program's Client Admin Panel)

July 24, 2018

Breaking changes to the newsfeed-events API:

  • Renamed GET /events to GET /newsfeed-events
  • Renamed GET /events/{newsfeedEventId} to GET /newsfeed-events/{newsfeedEventId}
  • Renamed GET /events/{newsfeedEventId}/likes to GET /newsfeed-events/{newsfeedEventId}/likes
  • Renamed GET /events/{newsfeedEventId}/comments to GET /newsfeed-events/{newsfeedEventId}/comments
  • Renamed GET /events/{newsfeedEventId}/boosts to GET /newsfeed-events/{newsfeedEventId}/boosts

May 18, 2018

Changes to the newsfeed-events API:

  • GET /events returns information about a collection of newsfeed events in the program
  • GET /events/{newsfeedEventId} returns information about an individual newsfeed event in the program
  • GET /events/{newsfeedEventId}/likes returns information about the user(s) who have liked the specified newsfeed event
  • GET /events/{newsfeedEventId}/comments returns information about the user(s) who have commented on the specified newsfeed event
  • GET /events/{newsfeedEventId}/boosts returns information about the user(s) who have given the specified newsfeed event a Boost

April 17, 2018

  • New uploads API allows you to upload custom images (for use in a recognition or in an achievement) and to retrieve images that have been uploaded for a user (see uploads for more information)
  • Added fileUploadId as an optional request parameter to POST /recognitions and POST /achievements

April 6, 2018

  • Access to GET /users/{userId} now requires user authorization (see Authentication for more information on the authorization code flow)

April 4, 2018

  • Added pointsBalance, pointsAccumulated, preferredLanguage, and timeZone attributes to response of GET /users/{userId}