absence.io offers a RESTful API, with which most of the absence entites can be retrieved, created, updated or deleted.
\nAll 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.
\nTo make a request with JSON, the appropriate HTTP headers are:
\nContent-Type: application/json\nAccept: application/json\nAuthorization: [See below for details]\n\nTo use the absence.io API you will need an API Key. To generate an API Key, please go to your profile in your absence.io account and click on the Integrations link.
Here you can generate an API Key by clicking on the 'Generate API Key' button.
The ApiKey consits of two parts:
\nThe Key Identifier (id) used to identify your key
\nThe actual key
\nFor transmitting your ApiKey we use Hawk.
\nHawk is an HTTP authentication scheme using a message authentication code (MAC) algorithm to provide partial HTTP request cryptographic verification.
See https://github.com/hueniverse/hawk for more details.
\nThe are numerous open source client implementations available on the internet:
\nJavascript/Node.js: https://github.com/hueniverse/hawk for more details
\nObjective C: https://github.com/tent/hawk-objc
\nA Hawk client requires you passing three parameters to its client/header method/function.
\nThis will usually look something like this:
\n var credentials = {\n id: '53ec476edf869a0200707ac3', // the key identifier\n key: 'werxhqb18rpaxn39848xrunpaw3489ruxnpa98w4rxn', // the actual key\n algorithm: 'sha256' // the algorythm used to build the request header\n };\n var header = Hawk.client.header(request.url,request.method,{ credentials: credentials});\n request.headers.Authorization = header.field; \n\nFor testing requests and gaining a better understanding of the API, we recommend you use Postman (https://www.getpostman.com) , which supports Hawk authentication out of the box.
\nOnce you have installed either the Postman client or the Postman extension for chrome, you can import this documention into Postman by clicking on the above Run in Postman button.
All requests have been set up so that you just need to set the following variables in a postman enviroment.
\nhawkId: the hawkId you got from us
\nhawkKey: the secrect hawk key you got from us
\nWhen these have been set up you just need to ensure that hawk authentication is enabled on all requests and click on Update Request in the Authorisation Tab.
Our API supports a customized implementation of the OAuth 2.0 Client Credentials Flow that allows applications to obtain access tokens on behalf of a specific user. This ensures that all subsequent API requests using the token will reflect the permissions and access rights of that user.
\nWhile the standard OAuth 2.0 Client Credentials Flow is meant for machine-to-machine communication with no user context, our implementation extends it to allow mapping the access token to a specific user.
\nA client authenticates using client_id and client_secret.
The API issues an access token tied to the permissions of the specified user.
\nAll API calls using this token operate within the scope of that user's role and permissions.
\nLog in to your absence.io account and navigate to the Integrations tab in your profile settings.
\nCreate a new OAuth client to obtain your unique client_id and client_secret.
POST https://app.absence.io/api/oauth/accesstoken\n\nContent-Type: application/x-www-form-urlencoded\n\nPOST /api/oauth/accesstoken\nHost: app.absence.io\nContent-Type: application/x-www-form-urlencoded\nclient_id=your_client_id&client_secret=your_client_secret&grant_type=client_credentials\n\n{\n \"access_token\": \"user_mapped_access_token\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 900\n}\n\nUse the access token to authenticate API requests. The token enforces the permissions of the mapped user.
\nGET /api/v1/teams\nHost: app.absence.io\nAuthorization: Bearer user_mapped_access_token\n\nAccess tokens typically expire after a set duration (e.g., 15 minutes). You can always request a new token by repeating the token request with the same credentials.
\nAll requests to create a new object follow the following pattern
\nHTTP POST https://app.absence.io/api/v2/[enitypath]/create
HTTP POST https://app.absence.io/api/v2/user\n{\n firstName:'Peter',\n lastName:'Mary',\n email:'peter.mary@johndoe.com'\n}\n\nwould result in a response similar to the following:
\n{\n _id:\"114f86b938d1a200300996e7a\"\n approverId:\"54fede756a42820300d74b7d\"\n avatar:\"\"\n company:\"54f81e196a72a10300e0f855\"\n created:\"2015-03-05T14:43:31.237Z\" \n email:\"absence.owner@testaccount.io\"\n firstLogin:false\n firstName:\"Peter\"\n holidayCountryLanguage:\"537eed02ed345b2e03965387\"\n holidayIds:[]\n holidaySubregion:\"custom\"\n holidays:[\"537eed02ed345b2e0396530c\", \"537eed02ed345b2e03965358\", \"537eed02ed345b2e0396535e\",…]\n id:\"54f86b938d1a200300996e7a\"\n ident:25\n inheritHolidays:true\n isApprover:false\n language:\"de\"\n lastName:\"Mary\"\n locationId:\"55bb1d28bb8cee0132771956\"\n modified:\"2015-03-05T14:43:31.237Z\"\n name:\"Peter Mary\"\n notes:\"\"\n role:\"000000000000000000001000\"\n status:1\n teamId:[\"54f8662b8d1a200300996de7\"]\n vacationDays:26\n workingDays:[[\"1970-01-01T00:00:00Z\", [1, 2, 3, 4, 5]]]\n}\n\nAll requests to update an object follow the following pattern
\nHTTP PUT https://app.absence.io/api/v2/[enitypath]/:id
The request body only needs to contain the properties that are to be changed.
\nThe response will contain the full updated object.
\nHTTP PUT https://app.absence.io/api/v2/users/114f86b938d1a200300996e7a\n{\n firstName:'Peter2'\n}\n\nwould result in a response similar to the following:
\n{\n _id:\"114f86b938d1a200300996e7a\"\n approverId:\"54fede756a42820300d74b7d\"\n avatar:\"\"\n company:\"54f81e196a72a10300e0f855\"\n created:\"2015-03-05T14:43:31.237Z\" \n email:\"absence.owner@testaccount.io\"\n firstLogin:false\n firstName:\"Peter2\"\n holidayCountryLanguage:\"537eed02ed345b2e03965387\"\n holidayIds:[]\n holidaySubregion:\"custom\"\n holidays:[\"537eed02ed345b2e0396530c\", \"537eed02ed345b2e03965358\", \"537eed02ed345b2e0396535e\",…]\n ident:25\n inheritHolidays:true\n isApprover:false\n language:\"de\"\n lastName:\"Mary\"\n locationId:\"55bb1d28bb8cee0132771956\"\n modified:\"2015-03-05T14:43:31.237Z\"\n name:\"Peter2 Mary\"\n notes:\"\"\n role:\"000000000000000000001000\"\n status:1\n teamId:[\"54f8662b8d1a200300996de7\"]\n vacationDays:26\n workingDays:[[\"1970-01-01T00:00:00Z\", [1, 2, 3, 4, 5]]]\n}\n\nAll GET requests for a single object follow the following pattern
\nHTTP GET https://app.absence.io/api/v2/[enitypath]/[id]
e.g. calling
\nHTTP GET https://app.absence.io/api/v2/users/53ec876edf869a0200707ac3\n\nwould result in a response like the following:
\nA full object as described in the respective entity documentation.
\n{\n _id: \"53ec876edf869a0200707ac3\"\n approverId:\"53ec876edf869a0200707ac3\", \n avatar: \"76e3fe57-7304-45d6-b722-dba53be05b7b\"\n email: \"john@doe.com\"\n firstName:\"John\",\n lastName:\"Doe\"\n ...\n}\n\nTo retrieve a list of objects, you must send a POST request which will follow the following pattern:
\nHTTP POST https://app.absence.io/api/v2/[enitypath]
HTTP POST https://app.absence.io/api/v2/users\n{\n skip:0,\n limit:50,\n filter: {\n name:'like john'\n }\n}\n\nwould result in a response like the following:
\n{\n skip:0,\n limit:50,\n count:50,\n totalCount:250,\n data: [\n .. array of user objects ..\n ]\n}\n\nFor further details on querying data, please see the section on querying.
\nWhen sending requests to the API you can expect the following HTTP Response Codes:
\nAll methods for listing data follow the conventions describe in the following.
\nThe http request body contains the following top level properties
\nThe http response body will contain the following properties:
\nThe filter object will usually contain one or more properties, specifing which rows to include/exclude in a query. If not filter or an empty filter object is passed, then all rows will be returned.
\nThe syntax used is very similar to the syntax mongo db
\n{ \n filter:{\n :\n }\n}\n\nWhere is a property of the object being queried and a value of the same type as .
For more complex queries can also be an object a query operator.
POST http://app.absence.io/api/v2/users\n{ \n filter:{\n firstName:'Peter'\n }\n}\nwill return all users, where the value of firstName is Peter.\n\nPOST http://app.absence.io/api/v2/absences\n{ \n filter:{\n assignedToId:'560bd9d03b4cbb24470ee7ee'\n }\n}\nwill return all absences, which are assignedTo the user with the id 560bd9d03b4cbb24470ee7ee\n\nQuery operators help you phrase more complex queries. Query operators all start with a $ as the first letter.
All queries support a sortBy Object, which can point to any properties on the main entity. Sort on relations is not supported.
\nThe following query will return all absences sorted by ascencding start date.
\nPOST http://app.absence.io/api/v2/absences\n{ \n sortBy:{\n start:1\n }\n}\n\nTo retrieve all absences sorted by descending start date, set the sortValue to -1.
e.g.
POST http://app.absence.io/api/v2/absences\n{ \n sortBy:{\n start:-1\n }\n}\n\nBy default, when passing mulitple properties in the filter object, an AND query will be peformed.
\nPOST http://app.absence.io/api/v2/users\n{ \n filter:{\n firstName:'Peter',\n lastName:'Mary'\n }\n}\nwill return all users, where the value of firstName is Peter AND the value of lastName is Mary. \n\nto turn this query into an OR query the following syntax does the job:
\nPOST http://app.absence.io/api/v2/users\n{ \n filter:{\n $or: [\n {firstName:'Peter'},\n {lastName:'Mary'}\n ]\n }\n}\nthis will return all users, where the value of firstName is Peter or the value of lastName is Mary. \n\nAND an OR can be also be combined:
\nPOST http://app.absence.io/api/v2/users\n{ \n filter:{\n locationId:'560bd9d03b4cbb24470ee7ee',\n $or: [\n {firstName:'Peter'},\n {lastName:'Mary'}\n ]\n }\n}\nthis will return all users belonging to the specified location AND whos firstName is Peter or whos lastName is Mary. \n\nWhen querying strings, by default a case-senstive exact match will be performed.
\nTo do a case insensitive substring match you can add a like at the begining of the string.
POST http://app.absence.io/api/v2/absences\n{ \n filter:{\n commentary:'like feeling blue'\n }\n}\nThis will return all absences in which the comment contains the string `feeling blue`.\n\nDate values must be passed in the ISO 8601 Format.
\nPOST http://app.absence.io/api/v2/absences\n{ \n filter:{\n start:'2015-04-23T00:00:00.000Z'\n }\n}\n\nor as YYYY-MM-DD
\nPOST http://app.absence.io/api/v2/absences\n{ \n filter:{\n start:'2015-04-23'\n }\n}\n\nwill evalue to '2015-04-23T00:00:00.000Z'
\nPOST http://app.absence.io/api/v2/absences\n{ \n sortBy:{'assignedToLastName':1}\n}\n\nPOST http://app.absence.io/api/v2/users\n{ \n \"filter\": {\n \"_id:absence.assignedTo\" : {\n \"start\": {\"$lte\" : \"2015-12-28T00:00:00.000Z\"},\n \"end\": {\"$gte\": \"2015-12-28T00:00:00.000Z\"},\n },\n \"teamId:teams._id\" :{\n name:'development'\n }\n }\n}\n\nUsing relations, you can tell the service to resolve id properties to their respective objects.
\nBy 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
\ne.g. To resolve the assignedToId to a property called assignedTo use the following syntax:
\nRequest\nPOST http://localhost:3000/api/v2/absences\n{ \n \"filter\": {\n \"start\": {\"$lte\" : \"2015-12-20T00:00:00.000Z\"},\n \"end\": {\"$gte\": \"2015-12-31T00:00:00.000Z\"}\n },\n relations:['assignedToId']\n}\n\nResponse\n{\n \"skip\": 0,\n \"limit\": 50,\n \"count\": 50,\n \"totalCount\": 458,\n \"data\": [\n {\n \"_id\": \"5480402809650202004df75b\",\n \"modified\": \"2014-12-06T10:04:39.006Z\",\n \"created\": \"2014-12-04T11:06:16.471Z\",\n \"start\": \"2014-12-03T00:00:00.000Z\",\n \"end\": \"2014-12-08T00:00:00.000Z\",\n \"assignedToId\": \"63ec876edf869a0200707ac3\",\n \"assignedTo\": {\n \"_id\": \"63ec876edf869a0200707ac3\", \n \"email\": \"absence.owner@gmail.com\",\n \"lastName\": \"Lebbe\",\n \"firstName\": \"Christina\", \n ...\n ...\n}\n\nCreate absences
\n","urlObject":{"path":["api","v2","absences","create"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d02c3522-dcc9-4282-9fca-9329ed9f5a3b"},{"name":"/api/v2/absences","id":"aa505fea-c92d-4fd4-8277-81f81adfedf5","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"Retrieve absences
\n","urlObject":{"path":["api","v2","absences"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"aa505fea-c92d-4fd4-8277-81f81adfedf5"},{"name":"/api/v2/absences/:id","id":"f2dfe93e-3ba1-4816-864b-8ca635215dc8","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"Update an existing absence
\n","urlObject":{"path":["api","v2","absences","56df2d3eaaac717e42f07115"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f2dfe93e-3ba1-4816-864b-8ca635215dc8"},{"name":"/api/v2/absences/:id","id":"8ab770dd-33c7-4e88-829a-86fdadac7492","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"Retrieve an absence
\n","urlObject":{"path":["api","v2","absences","56df2d3eaaac717e42f07115"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8ab770dd-33c7-4e88-829a-86fdadac7492"}],"id":"f9036934-35b1-486e-a17b-1599c30f0097","description":"The absence object represents one absence for one user.
\nBy default only \"visible\" absences are returned. In other words, absences which have beend rejected or deleted, will not be returned.
\nassuming that today is the 2015-12-28 the follwoing query would return all absences today
\n","urlObject":{"path":["api","v2","absences"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6f6f8b62-9415-4204-95dd-ee2748f7e350"},{"name":"All absences inside a date range","id":"09f7bfb3-cc36-4373-9158-6db114e9f799","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"To get all absences between 2015-12-20 and 2015-12-31, use the following query. \n(Note: that the start and end dates have been exchanged)
\n","urlObject":{"path":["api","v2","absences"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"09f7bfb3-cc36-4373-9158-6db114e9f799"},{"name":"All absences of a user by userId","id":"f4673e22-ff6b-4422-b42f-08458b1beca1","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"The following query will return all absences where the comment contains the word test
\n","urlObject":{"path":["api","v2","absences"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d38860c0-207a-4cc2-9d63-3935e3c466e3"},{"name":"Everybody on vacation today","id":"266a23a1-29d7-4042-8ce2-a7aab16f6638","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"assuming that today is the 2015-12-28 that the reason id for vacation is \"53ec876edf869a0200707ac5\" the follwoing query would return all absences today of type vacation
\n","urlObject":{"path":["api","v2","absences"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"266a23a1-29d7-4042-8ce2-a7aab16f6638"},{"name":"All absences with the reason name vacation","id":"32db91c1-2a80-446a-a685-c651d606dc71","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"POST http://app.absence.io/api/v2/absences\n{ \n filter:{\n start:{$gte:'2015-01-01'}\n }\n}\nwill return all absences starting after or on January 1st 2015\n\nRetrieve allowance types
\n","urlObject":{"path":["api","v2","allowancetypes"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d3f7437a-e8ca-4d92-800f-fc2bf6039caf"},{"name":"/api/v2/allowancetypes/:id","id":"aea261ed-d5e3-4198-8468-e46d50f39b11","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"Retrieve a single allowance type
\n","urlObject":{"path":["api","v2","allowancetypes","556748828e3c265c4a601568"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"aea261ed-d5e3-4198-8468-e46d50f39b11"}],"id":"17442147-d7e7-4be9-88ee-55f17af2b91d","description":"Represents the configuration for a yearly allowance assiociated to a one or more absence reasons.
\ne.g. \n A user might have a yearly allowance of 28 days.
\nRetrieve departments
\n","urlObject":{"path":["api","v2","departments"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6bb6ca14-2518-4026-91ab-ba1b9a9cee62"},{"name":"/api/v2/deparments/:id","id":"813c2fc9-6845-4530-a10d-e66cedbdbd55","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"Retrieve a single department
\n","urlObject":{"path":["api","v2","departments","56cd765ee271f1531205015c"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"813c2fc9-6845-4530-a10d-e66cedbdbd55"}],"id":"9b1ba0b6-4596-442c-85aa-1e0c1be62f5b","description":"Represents a department to which a user belongs. A user can only be member of one department.
\nRetrieve locations
\n","urlObject":{"path":["api","v2","locations"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7ab4afd7-1583-4bf4-8ba3-e3e9a0d066b3"},{"name":"/api/v2/locations/:id","id":"d668042a-8e2e-4f4d-9575-8586a0413aa1","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"Retrieve a single location
\n","urlObject":{"path":["api","v2","locations","55c10afb207236e26f729c81"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d668042a-8e2e-4f4d-9575-8586a0413aa1"}],"id":"f61830d3-49e9-42a8-bf4e-1df3fe674787","description":"Represents the physical location of user. A user can only be a member of one location.
\nRetrieve reasons
\n","urlObject":{"path":["api","v2","reasons"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b2fd9b4b-2a6d-41da-8f56-62bf803b8b62"},{"name":"/api/v2/reasons/:id","id":"d90e265d-01e2-4f48-8fdd-e92c0067d933","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"Retrieve a single reason
\n","urlObject":{"path":["api","v2","reasons","53ec876edf869a0200707ac5"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d90e265d-01e2-4f48-8fdd-e92c0067d933"}],"id":"84bb3ce4-db50-4890-9592-5baa5602cc0b","description":"Defines a absence reason. e.g. vacation, sickness, home office
\nRetrieve teams
\n","urlObject":{"path":["api","v2","teams"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"00553659-bd5d-4831-b15f-ca0bb7af9768"},{"name":"/api/v2/teams/:id","id":"53759843-0fcb-4dc3-a7ce-ab0236902e3a","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"Retrieve a single team
\n","urlObject":{"path":["api","v2","teams","56968e30a4c5b7f74f82718b"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"53759843-0fcb-4dc3-a7ce-ab0236902e3a"}],"id":"900ccfac-5383-4160-a7a0-91fe87888081","description":"Represent a team inside a company. A user can a member of multiple teams.
\nRegister a new user for your company. The newly created user will recieve an invitation email.
\n","urlObject":{"path":["api","v2","users","invite"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fd581689-3351-4709-9f16-5b36d898579a"},{"name":"/api/v2/users","id":"c930a947-51bf-4d90-84e8-3a2e0db64db6","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"Retrieve users
\n","urlObject":{"path":["api","v2","users"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c930a947-51bf-4d90-84e8-3a2e0db64db6"},{"name":"/api/v2/user/:id","id":"4310054e-cfc6-47cc-851a-5a2bee22f2a1","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"Retrieve a user
\n","urlObject":{"path":["api","v2","users","553748e9eed02b03007fa7b3"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4310054e-cfc6-47cc-851a-5a2bee22f2a1"},{"name":"/api/v2/users/:id","id":"abc38b67-7f19-4503-9b61-3d549e66b406","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"Update an existing user
\n","urlObject":{"path":["api","v2","users","553748e9eed02b03007fa7b3"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"abc38b67-7f19-4503-9b61-3d549e66b406"}],"id":"340c5d8a-0552-40be-aeec-bd8411632a17","description":"The user object represents one registered user in absence.io
\nBy default only \"active\" users, i.e. users which can login and create absences, are returned. This means that inactive and deleted users are filtered out. (Delete users are physically deleted 30 days after the deletion)
\nWorking days define the days in a week a user is expected to be working and allows a company to define work weeks on a per user basis. \nFor example:
\nAbsences only count defined working days when calculating total days and reducing allowances\nWorking days array must be sent in full during update. If only one entry is sent the server will assume the user only has one entry in their working days\nExample:
workingDays: [\n ['1970-01-01', [1,2,3,4,5]], // Starting Jan 1, 1970 the user will be working mon-fri\n ['2015-03-01', [0,1,2,3]], // Starting Mar 1, 2015 the user will be working sun-wed\n ]; \nRegister a new user for your company. The newly created user will NOT recieve an invitation email.
\n","urlObject":{"path":["api","v2","users","invite"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"414ec698-9b1e-4893-979b-a9678252e6f5"}],"id":"e39b74b8-e094-4b3b-a9ef-6cb3f6f22c5c","_postman_id":"e39b74b8-e094-4b3b-a9ef-6cb3f6f22c5c","description":""},{"name":"user: query examples","item":[{"name":"Find users by lastName","id":"4e483d15-fee3-437a-8137-3422894bf098","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"Will find all users whose firstname is either peter, paul or mary
\n","urlObject":{"path":["api","v2","users"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"40f62b69-3f6b-4b0e-82c9-8b79e28b6d8f"},{"name":"Find users by names and location Id","id":"0fbc7686-24fc-4c38-bde6-544aa12a0879","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"Will find all users which match the given location id and whose firstName is peter or lastName is mary.
\n","urlObject":{"path":["api","v2","users"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0fbc7686-24fc-4c38-bde6-544aa12a0879"},{"name":"Find all approvers of a specific department","id":"73658443-7ddd-4906-a507-79c5d19cfc34","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"Retrieves a single time entry.
\n","urlObject":{"protocol":"https","path":["api","v2","timespans","{{timespanId}}"],"host":["app","absence","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"f7f099d6-68ac-4bef-aaca-83cc0da9cacd"},{"name":"/api/v2/timespans","id":"4324cdc4-0557-440c-8b72-e453318c102f","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"Queries a list of time entries.
\n","urlObject":{"protocol":"https","path":["api","v2","timespans"],"host":["app","absence","io"],"query":[],"variable":[]}},"response":[{"id":"662b6bb4-89b6-426a-8fd3-bef03c44262a","name":"Get Clocked-in Timespans","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filter\": {\n \"type\": \"work\",\n \"end\": null\n },\n \"skip\": 0,\n \"limit\": 50\n}","options":{"raw":{"language":"json"}}},"url":"https://app.absence.io/api/v2/timespans"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"skip\": 0,\n \"limit\": 50,\n \"count\": 1,\n \"totalCount\": 1,\n \"data\": [\n {\n \"compensations\": [],\n \"source\": {\n \"sourceType\": \"\",\n \"sourceId\": \"\"\n },\n \"_id\": {{timespanId}},\n \"type\": \"work\",\n \"start\": \"2023-01-02T10:35:54.167Z\",\n \"end\": null,\n \"commentary\": null,\n \"timezone\": \"+0100\",\n \"millisecondOffset\": 3600000,\n \"timezoneName\": \"Central European Standard Time\",\n \"createdOn\": \"2023-01-02T10:35:54.571Z\",\n \"modifiedOn\": \"2023-01-02T10:35:54.571Z\",\n \"userId\": {{userId}},\n \"companyId\": {{companyId}},\n \"modifiedById\": {{userId}},\n \"createdById\": {{userId}},\n \"labelIds\": [],\n \"effectiveStart\": \"2023-01-02T10:35:00.000Z\",\n \"startInTimezone\": \"2023-01-02T11:35:54.167+01:00\"\n }\n ]\n}"},{"id":"a016c578-2418-44e2-acd0-684c7e51ccab","name":"Get Open Break Timespans","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filter\": {\n \"type\": \"break\",\n \"end\": null\n },\n \"skip\": 0,\n \"limit\": 50\n}","options":{"raw":{"language":"json"}}},"url":"https://app.absence.io/api/v2/timespans"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"skip\": 0,\n \"limit\": 50,\n \"count\": 1,\n \"totalCount\": 1,\n \"data\": [\n {\n \"compensations\": [],\n \"source\": {\n \"sourceType\": \"\",\n \"sourceId\": \"\"\n },\n \"_id\": {{timespanId}},\n \"type\": \"break\",\n \"start\": \"2023-01-02T10:35:54.167Z\",\n \"end\": null,\n \"commentary\": \"out for lunch\",\n \"timezone\": \"+0100\",\n \"millisecondOffset\": 3600000,\n \"timezoneName\": \"Central European Standard Time\",\n \"createdOn\": \"2023-01-02T10:35:54.571Z\",\n \"modifiedOn\": \"2023-01-02T10:35:54.571Z\",\n \"userId\": {{userId}},\n \"companyId\": {{companyId}},\n \"modifiedById\": {{userId}},\n \"createdById\": {{userId}},\n \"labelIds\": [],\n \"effectiveStart\": \"2023-01-02T10:35:00.000Z\",\n \"startInTimezone\": \"2023-01-02T11:35:54.167+01:00\"\n }\n ]\n}"}],"_postman_id":"4324cdc4-0557-440c-8b72-e453318c102f"},{"name":"/api/v2/timespans/create","id":"07d820c1-36b5-4e7c-b511-42e0ee8f53af","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"Creates a new time entry.
\n","urlObject":{"protocol":"https","path":["api","v2","timespans","create"],"host":["app","absence","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"07d820c1-36b5-4e7c-b511-42e0ee8f53af"},{"name":"/api/v2/timespans/:id","id":"3bd58d53-f666-438c-9076-dff887601ed8","request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"Modifies one time entry.
\n","urlObject":{"protocol":"https","path":["api","v2","timespans","{{timespanId}}"],"host":["app","absence","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"3bd58d53-f666-438c-9076-dff887601ed8"},{"name":"/api/v2/timespans/:id","id":"090e261b-c3ce-4aca-9d97-957adb409930","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"hawk","hawk":{"authId":"{{hawkId}}","authKey":"{{hawkKey}}","algorithm":"Deletes one time entry.
\n","urlObject":{"protocol":"https","path":["api","v2","timespans","{{timespanId}}"],"host":["app","absence","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"090e261b-c3ce-4aca-9d97-957adb409930"}],"id":"aba54999-2c0b-4fc2-afef-c8f2785c8a6f","description":"Represent a single timetracking entry. Timespans can currently represent work or breaks.
\nThis endpoint retrieves holidays for a user or location within a specified date range. It supports filtering by user, location, company, day type, and mandatory leave status.
\nBehavior for userId and locationId:
userId and locationId are mutually exclusive. If both are provided, userId takes precedence.Behavior for companyId:
companyId is not provided, the endpoint returns both public and custom holidays.companyId is null, the endpoint returns only public holidays.companyId is set to a specific value (e.g., <companyId>), the endpoint returns only custom holidays for that company.Endpoints related to holidays.
\n","_postman_id":"f0eb475d-fa63-471d-9529-2215c2128ce8"}],"event":[{"listen":"prerequest","script":{"id":"a25e1ef0-398c-4e31-970e-eab6071d86f5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7e106c3f-9ad1-4626-b0f7-5ea9f505a3be","type":"text/javascript","exec":[""]}}]}