Authentication
Authentication is done via an API key - each API key will have access to at least one field in at least one endpoint. Additionally the API key may be able to Create, Read, Update or Delete data depending on the permissions.
Authentication is achieved by the use of a Header called Authorization (note spelling for non US users) - to this header you simply pass your API key like the example below:
curl --request GET \
--url https://api02.naturalhr.net/api/v1/employee \
--header 'Authorization: YOUR_API_KEY'
--header 'Accept: application/json'
--header 'Content-type: application/json'
We also recommend sending an additional header for Content-type which indicates that the returned data will be in JSON format.
Updated over 3 years ago