0

Retrieve Employee Time Off Data for Offboarding

by
Published Oct 17, 2025

This endpoint provides detailed time off information for an employee, including accrued, used, and scheduled days across all tracking periods. It also includes policy details, tracking configurations, and additional metadata to support the offboarding request process. The data is used to display comprehensive time off information on the offboarding request page. **Token scopes**: `contracts:read`

Script deel Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
/**
3
 * Retrieve Employee Time Off Data for Offboarding
4
 * This endpoint provides detailed time off information for an employee, including accrued, used, and scheduled days across all tracking periods. It also includes policy details, tracking configurations, and additional metadata to support the offboarding request process. The data is used to display comprehensive time off information on the offboarding request page.
5
 **Token scopes**: `contracts:read`
6
 */
7
export async function main(auth: RT.Deel, contract_id: string, end_date?: string | undefined) {
8
	const url = new URL(
9
		`https://api.letsdeel.com/rest/v2/eor/contracts/${contract_id}/offboarding/time-offs`
10
	)
11
	for (const [k, v] of [['end_date', end_date]]) {
12
		if (v !== undefined && v !== '') {
13
			url.searchParams.append(k, v)
14
		}
15
	}
16
	const response = await fetch(url, {
17
		method: 'GET',
18
		headers: {
19
			Authorization: 'Bearer ' + auth.apiKey
20
		},
21
		body: undefined
22
	})
23
	if (!response.ok) {
24
		const text = await response.text()
25
		throw new Error(`${response.status} ${text}`)
26
	}
27
	return await response.json()
28
}
29