0

Retrieve onboarding right-to-work case for a worker

by
Published Oct 17, 2025

Returns the right to work case for employee onboarding including the documents if any. In case no right to work case is open, the response will be empty. **Token scopes**: `worker:read`

Script deel Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
/**
3
 * Retrieve onboarding right-to-work case for a worker
4
 * Returns the right to work case for employee onboarding including the documents if any. In case no right to work case is open, the response will be empty.
5
 **Token scopes**: `worker:read`
6
 */
7
export async function main(auth: RT.Deel, worker_id: string) {
8
	const url = new URL(
9
		`https://api.letsdeel.com/rest/v2/immigration/workers/${worker_id}/onboarding-case`
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