API Documentation

absence.io offers a RESTful API, with which most of the absence entities can be retrieved, created, updated or deleted.

All API urls are below the url path https://app.absence.io/api/v2/[....]

The absence.io API only supports the JSON format for sending and retrieving data.

 

Introduction

Click here to build own absence.io plugins or/and to integrate absence.io into custom systems.

 

Authentication

To use the absence.io API you will need an API Key. To generate one, please go to your profile in your absence.io account and click on the Integrations tab and click on the 'Generate API Key' button.

The ApiKey consists of two parts:

  • The Key Identifier (id) used to identify your key
  • The actual key

For transmitting your ApiKey we use Hawk. Click here to find out more!

 

General Concepts

Here you can find a general overview about our Api and it's functions.

 

HTTP Response codes

Click here to find out more about response codes you can expect when sending requests to the API.

 

Querying Objects

All requests respect one format that can be found here in more detail.

 

Response

Using relations, you can tell the service to resolve id properties to their respective objects.

By adding a relations array to the request body, you tell the server to load the full object for the id property of the main entity

e.g. To resolve the assignedToId to a property called assignedTo use the following syntax:

 

Request
POST http://localhost:3000/api/v2/absences
{ 
    "filter": {
            "start": {"$lte" : "2015-12-20T00:00:00.000Z"},
            "end": {"$gte": "2015-12-31T00:00:00.000Z"}
    },
    relations:['assignedToId']
}

 

Response
{
  "skip": 0,
  "limit": 50,
  "count": 50,
  "totalCount": 458,
  "data": [
    {
      "_id": "5480402809650202004df75b",
      "modified": "2014-12-06T10:04:39.006Z",
      "created": "2014-12-04T11:06:16.471Z",
      "start": "2014-12-03T00:00:00.000Z",
      "end": "2014-12-08T00:00:00.000Z",
      "assignedToId": "63ec876edf869a0200707ac3",
      "assignedTo": {
        "_id": "63ec876edf869a0200707ac3",   
        "email": "absence.owner@gmail.com",
        "lastName": "Lebbe",
        "firstName": "Christina",      
     ...
     ...

}

 

More

Specific information and more examples regarding each entity can be found here.

 

Enjoy our solution!

 

You absence.io team

Was this article helpful? 0 out of 0 found this helpful