Get started with the REST API for OrangeHRM Open Source
Introduction
Welcome to the documentation for OrangeHRM Starter REST API v2! This guide will help you get started with integrating and utilizing our API in your applications.
Which OrangeHRM Starter version?
This API is compatible with OrangeHRM Starter 5.5 and above. Certain endpoints may not be available on previous 5.x versions.
If you are using a 4.x version of OrangeHRM Starter, please refer to our API v1 documentation.
Making API calls
In order to integrate our REST API, you will need to obtain an access token in order to make API calls. The access token will need to be provided as a Bearer Token in your authorization headers. An example request is given below in cURL but you can use any language of your choice.
curl http://your_url/web/index.php/api/v2/admin/educations/1 \
-H 'Authorization: Bearer your_access_token'
Getting an Access Token
The next section of this documentation will provide a step by step guide on how to create an OAuth 2.0 client within the OrangeHRM starter application and how to obtain an access token.
Try it Yourself!
You can try out our APIs from within this documentation. Check out our Try It Yourself! section to learn how!