How to generate an Access token
To use AlexisHR's API you need an Access Token. Since the API connects you to all information available about employees in AlexisHR you need to be an Owner to create this (see this article about Permissions).
If you are an Owner you can generate the Access token in Settings -> Access tokens.
You can choose if the Access token should allow for API access to the Public API and/or the Provisioning API.
Note: The token created will only be visible once, so make sure to keep it safe! The access token will be tied to the user who created it, so if the user that created the token has its permission changed or if it's removed the token will become invalid.
General information
Currently it's only possible to access the API as an Owner, meaning all endpoints and information about everything is possible to GET, PATCH and POST to via the above generated access token.
The API supports QUERY PARAMETERS as select, relations, filters, limit, offset and sort. Different endpoints might have limitations in this support though.
Documentation about AlexisHR's Public API
Our API documentation is available at docs.alexishr.com. There you can subscribe to emails about updates and read everything there is to know about the API.
Documentation about AlexisHR's Provisioning API
Our API documentation is available at https://docs.alexishr.com/scim/. There you can subscribe to emails about updates and read everything there is to know about the API.