List the caller's leave balances.

curl --request GET \
  --url https://{tenantHost}/api/v1/portal/employee/leave-balances

const options = {method: 'GET'};

fetch('https://{tenantHost}/api/v1/portal/employee/leave-balances', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantHost}/api/v1/portal/employee/leave-balances",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantHost}/api/v1/portal/employee/leave-balances"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{tenantHost}/api/v1/portal/employee/leave-balances")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": [
    {
      "leaveType": "VACATION",
      "entitlement": 123,
      "used": 123,
      "planned": 123,
      "carriedOver": 123,
      "remaining": 123
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

GET

api

portal

employee

leave-balances

List the caller's leave balances.

curl --request GET \
  --url https://{tenantHost}/api/v1/portal/employee/leave-balances

const options = {method: 'GET'};

fetch('https://{tenantHost}/api/v1/portal/employee/leave-balances', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantHost}/api/v1/portal/employee/leave-balances",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantHost}/api/v1/portal/employee/leave-balances"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{tenantHost}/api/v1/portal/employee/leave-balances")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": [
    {
      "leaveType": "VACATION",
      "entitlement": 123,
      "used": 123,
      "planned": 123,
      "carriedOver": 123,
      "remaining": 123
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Query Parameters

year

integer

Calendar year to filter by. Defaults to the current year.

Response

The caller's leave balances for the year.

success

enum<boolean>

required

Available options:

true

data

object[]

required

Show child attributes

Introduction

Employee portal API

List the caller's leave balances.

Query Parameters

Response