Quick Start

Good to know: A quick start guide can be good to help folks get up and running with your API in a few steps. Some people prefer diving in with the basics rather than meticulously reading every page of documentation!

You must have booked the Enterprise Plan

Get your API Key

Your API requests are authenticated using an API Key. Any request that doesn't include an API Key will return an error.

You can request an API Key from the absentify Dashboard at any time.

Overview<!-- --> - absentify

For more details on Authenticating API requests with an API Key jump into the Authentication section.

pageAuthentication

Make your first request

To make your first request, send an authenticated request to the requests endpoint. This will return a list of your current Requests.

Get all requests

Get all requests

GEThttps://api.absentify.com/api/v1/requests

Authorization

ApiKey

Query parameters

Response

200default

Successful response

Body

application/json

id*string

createdAt*string (date-time)

updatedAt*string (date-time)

end*string (date-time)

start*string (date-time)

end_at*enum

lunchtimeend_of_day

start_at*enum

morningafternoon

request_creator_member*nullable object

leave_type*object

approval_process*enum

Linear_all_have_to_agreeLinear_one_has_to_agreeParallel_all_have_to_agreeParallel_one_has_to_agree

cancel_reason*nullable string

canceld_by_member*nullable object

requester_member*nullable object

reason*nullable string

take_from_allowance*boolean

allowance_type*nullable object

workday_absence_duration*number

status*string

canceld_date*nullable string (date-time)

request_approvers*array of object

Request

JavaScriptCurl

const response = await fetch('https://api.absentify.com/api/v1/requests', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "createdAt": "2024-04-18T22:37:38.636Z",
    "updatedAt": "2024-04-18T22:37:38.636Z",
    "end": "2024-04-18T22:37:38.636Z",
    "start": "2024-04-18T22:37:38.636Z",
    "end_at": "lunchtime",
    "start_at": "morning",
    "request_creator_member": {
      "id": "text",
      "custom_id": "text",
      "name": "text",
      "email": "text"
    },
    "leave_type": {
      "name": "text",
      "id": "text"
    },
    "approval_process": "Linear_all_have_to_agree",
    "cancel_reason": "text",
    "canceld_by_member": {
      "id": "text",
      "custom_id": "text",
      "name": "text",
      "email": "text"
    },
    "requester_member": {
      "id": "text",
      "custom_id": "text",
      "name": "text",
      "email": "text"
    },
    "reason": "text",
    "take_from_allowance": false,
    "allowance_type": {
      "id": "text",
      "name": "text",
      "default": false,
      "ignore_allowance_limit": false
    },
    "workday_absence_duration": 0,
    "status": "text",
    "canceld_date": "2024-04-18T22:37:38.636Z",
    "request_approvers": [
      {
        "reason": "text",
        "status": "PENDING",
        "status_changed_by_member": {
          "id": "text",
          "custom_id": "text",
          "name": "text",
          "email": "text"
        },
        "status_changed_date": "2024-04-18T22:37:38.636Z",
        "approver_member": {
          "id": "text",
          "custom_id": "text",
          "name": "text",
          "email": "text"
        }
      }
    ]
  }
]

Take a look at how you might call this method using curl: