0

Get sync settings

by
Published Oct 17, 2025

Retrieve the [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for your client. This includes how often data types should be queued to be updated, and how much history should be fetched.

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 sync settings
7
 * Retrieve the [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for your client. This includes how often data types should be queued to be updated, and how much history should be fetched.
8
 */
9
export async function main(auth: Codat) {
10
	const url = new URL(`https://api.codat.io/profile/syncSettings`)
11

12
	const response = await fetch(url, {
13
		method: 'GET',
14
		headers: {
15
			Authorization: `Basic ${auth.encodedKey}`
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