Download OpenAPI specification:Download
curl https://api.alexishr.com/v1/employee \ -H "Authorization: Bearer <your_access_token>"
Authenticate your account when using the API by including your secret Access Token in the request. Manage your Access Tokens.
Authentication is performed by passing the Access Token in the Authorization header.
You will find the structure of the API to be highly uniform and consistent.
Typically every resource can be accessed via a top level endpoint, such as
/v1/employee. For every such resource, you can perform some of
the following operations:
|GET /v1/:resource||List all objects of this type|
|GET /v1/:resource/:id||Retrieve a resource by id|
|POST /v1/:resource||Create a resource of this type|
|PATCH /v1/:resource/:id||Update the resource by id|
|DELETE /v1/:resource/:id||Delete the resource by id|
The Access Tokens will have owner permission on the account
Some of the list endpoints allow to filter results by certain conditions. Refer to specific resources to find out what criteria are allowed. Below is a list of the different conditions.
Find all results matching the attribute value specified.
Can also be simplified like this.
Find all results not matching the attribute value specified.
Find all results where the value is more (
$gt) or more and equal
$gte) to a given value.
Find all results where the value is less (
$lt) or less and equal
$lte) to a given value.
Find all results matching (
$in) or not matching
$nin) any of the attribute values specified.
Find all results between two values specified.
Each version of the API is guaranteed to be compatible with the resources of the same version. When we make breaking changes to the API a new version will be published
First draft was published