Skip to main content

2025-3 API release notes

Shirley Bousfield
Updated
api-release_1.svg

This release introduces improvements to the help page for the API which provides additional information about the API and how its end points work without the need to enter an API Key.
 

Help page improvements

There are now multiple tabs available on the help page:

Overview

  • This tab gives an overview about the API with some guidance on how to get started
     

Authentication

  • This has been improved so you can view example end points without having to enter an API key
  • Entering an API key will then show the full list of available endpoints
     

Query Parameters

  • This tab shows examples and guidance on how you can use query parameters in the API calls to filter the results of an endpoint
     

Operations

  • This section gives examples of end points that may be available to the users

Notes: 

  • The examples for HR API are written to show end points that the API Key may have access to
  • Other API (iRecruit/LMS) examples will only show dummy end points to represent the structure, rather than mirror what a valid API Key will provide

 

 

Notes: 

  • These changes do not expose the full list of end points available to the user’s API key:
    • The end point examples provided are purely a sample of the end points that could be available to the user when using the API Key
    • To get the actual list of available end points, the user will need to enter a valid API Key via the new Authentication tab

 

Footer

Related articles

Comments

0 comments

Article is closed for comments.