Announcement: Non-Employee Risk Management API - Change to GET request responses for/api/profiles

Announcements Product News
, ,
1

The Non-Employee Risk Management team is informing you about an upcoming change to our API that will affect how GET requests are handled for profiles, in cases where the after_id and metadata parameters are used.

For more information on these parameters, please consult our API documentation:

  • Background
    • In GET requests to /api/profiles, the after_id parameter represents the Profile ID from where the query should begin. When used, forces sorting by ID ascending and does not allow use of offset. When after_id is specified it changes the mode of the API such that any filter parameters other than profile_type_id, limit, and offset are not supported and will be either silently ignored or result in an HTTP 400 error.
    • In responses to GET requests to /api/profiles, the metadata attribute after_id reflects the ID from which the search will start, ignoring all records before it.
  • Problem
    • Previously, in cases where there are no more profiles to retrieve, the system had been sending a 400 (bad request) response.
  • What is changing?
    • The NERM API will now return a 200 response with a nil value on the after_id metadata attribute to indicate there are no more profiles to retrieve.
  • Which API endpoints are affected by this change?
    • /api/profiles
  • When will this change go into effect?
    • May 19, 2025

Thank you for your understanding and cooperation.

1 Like