A person's leave balances
curl --request GET \
--url https://api.v3.andteam.com/v1/employees/{id}/leave-balances \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.v3.andteam.com/v1/employees/{id}/leave-balances"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.v3.andteam.com/v1/employees/{id}/leave-balances', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.v3.andteam.com/v1/employees/{id}/leave-balances"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": [
{
"leaveTypeId": "<string>",
"available": 123,
"booked": 123,
"unit": "days",
"asAt": "<string>",
"source": "andteam",
"unavailableReason": "no_policy",
"taken": 123,
"carried": 123,
"expiring": [
{
"amount": 123,
"on": "<string>"
}
]
}
],
"next_cursor": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}Leave
A person's leave balances
Needs the Leave field group. None for a sick type or a type that keeps no balance. With source: payroll the figure is payroll’s own, with its own asAt, and has no taken; andteam never computes a second one. A type with no figure is returned with available: null and an unavailableReason (no_policy or payroll_unreachable), never zero and never omitted. With source: andteam, a type with a carry-over rule also has carried and expiring (the carried days that expire, and when). Only types offered to the person’s worker type are listed.
GET
/
employees
/
{id}
/
leave-balances
A person's leave balances
curl --request GET \
--url https://api.v3.andteam.com/v1/employees/{id}/leave-balances \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.v3.andteam.com/v1/employees/{id}/leave-balances"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.v3.andteam.com/v1/employees/{id}/leave-balances', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.v3.andteam.com/v1/employees/{id}/leave-balances"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": [
{
"leaveTypeId": "<string>",
"available": 123,
"booked": 123,
"unit": "days",
"asAt": "<string>",
"source": "andteam",
"unavailableReason": "no_policy",
"taken": 123,
"carried": 123,
"expiring": [
{
"amount": 123,
"on": "<string>"
}
]
}
],
"next_cursor": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>",
"instance": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"detail": "<string>"
}
],
"fields": [
"<string>"
],
"existingId": "<string>",
"step": "<string>"
}Authorizations
apiKeyoauth
Authorization: Bearer atk_live_… (a sandbox's keys are atk_test_…). Created in the API keys section of the Integrations settings; the secret is shown once.
Path Parameters
The employee id.
Query Parameters
One of the key's companies.