0

Get custom data configuration

by
Published Oct 17, 2025

The *Get custom data configuration* endpoint returns existing configuration details for the specified custom data type and integration pair you previously configured. A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat's standardized data model.

Script codat Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Codat = {
3
	encodedKey: string
4
}
5
/**
6
 * Get custom data configuration
7
 * The *Get custom data configuration* endpoint returns existing configuration details for the specified custom data type and integration pair you previously configured.
8

9
A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat's standardized data model.
10
 */
11
export async function main(auth: Codat, platformKey: string, customDataIdentifier: string) {
12
	const url = new URL(
13
		`https://api.codat.io/integrations/${platformKey}/dataTypes/custom/${customDataIdentifier}`
14
	)
15

16
	const response = await fetch(url, {
17
		method: 'GET',
18
		headers: {
19
			Authorization: `Basic ${auth.encodedKey}`
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