0

List Custom Report Column Labels

by
Published Oct 17, 2025

This endpoint provides human-readable labels for report table columns. It is particularly important if you get a report with custom attributes or absence data to match the column IDs to the translation.

Script personio Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Personio = {
3
	clientId: string
4
	clientSecret: string
5
}
6
/**
7
 * List Custom Report Column Labels
8
 * This endpoint provides human-readable labels for report table columns. It is particularly important if you get a report with custom attributes or absence data to match the column IDs to the translation.
9
 */
10
export async function main(
11
	auth: Personio,
12
	columns: string | undefined,
13
	locale: string | undefined,
14
	report_id: string | undefined,
15
	X_Personio_Partner_ID?: string,
16
	X_Personio_App_ID?: string
17
) {
18
	const url = new URL(`https://api.personio.de/v1/company/custom-reports/columns`)
19
	for (const [k, v] of [
20
		['columns', columns],
21
		['locale', locale],
22
		['report_id', report_id]
23
	]) {
24
		if (v !== undefined && v !== '' && k !== undefined) {
25
			url.searchParams.append(k, v)
26
		}
27
	}
28
	const response = await fetch(url, {
29
		method: 'GET',
30
		headers: {
31
			...(X_Personio_Partner_ID ? { 'X-Personio-Partner-ID': X_Personio_Partner_ID } : {}),
32
			...(X_Personio_App_ID ? { 'X-Personio-App-ID': X_Personio_App_ID } : {}),
33
			Authorization: 'Bearer ' + (await getOAuthToken(auth, 'https://api.personio.de/oauth2/token'))
34
		},
35
		body: undefined
36
	})
37
	if (!response.ok) {
38
		const text = await response.text()
39
		throw new Error(`${response.status} ${text}`)
40
	}
41
	return await response.json()
42
}
43

44
async function getOAuthToken(auth: Personio, tokenUrl: string): Promise<string> {
45
	const params = new URLSearchParams({
46
		grant_type: 'client_credentials',
47
		client_id: auth.clientId,
48
		client_secret: auth.clientSecret
49
	})
50

51
	const response = await fetch(tokenUrl, {
52
		method: 'POST',
53
		headers: {
54
			Authorization: 'Basic ' + btoa(`${auth.clientId}:${auth.clientSecret}`),
55
			'Content-Type': 'application/x-www-form-urlencoded'
56
		},
57
		body: params.toString()
58
	})
59

60
	if (!response.ok) {
61
		const text = await response.text()
62
		throw new Error(`OAuth token request failed: ${response.status} ${text}`)
63
	}
64

65
	const data = await response.json()
66
	return data.access_token
67
}
68