0

Get onboarding details by employee HRIS profile ID

by
Published Oct 17, 2025

Use this endpoint to retrieve a comprehensive overview of a worker's onboarding status, including their profile details, contract status, and checklist progress. **Token scopes**: `contracts:read`, `people:read`

Script deel Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
/**
3
 * Get onboarding details by employee HRIS profile ID
4
 * Use this endpoint to retrieve a comprehensive overview of a worker's onboarding status, including their profile details, contract status, and checklist progress.
5
 **Token scopes**: `contracts:read`, `people:read`
6
 */
7
export async function main(auth: RT.Deel, hris_profile_id: string) {
8
	const url = new URL(
9
		`https://api.letsdeel.com/rest/v2/onboarding/tracker/hris_profile/${hris_profile_id}`
10
	)
11

12
	const response = await fetch(url, {
13
		method: 'GET',
14
		headers: {
15
			Authorization: 'Bearer ' + auth.apiKey
16
		},
17
		body: undefined
18
	})
19
	if (!response.ok) {
20
		const text = await response.text()
21
		throw new Error(`${response.status} ${text}`)
22
	}
23
	return await response.json()
24
}
25