0

Get Field Options

by
Published Oct 17, 2025

Use this resource to retrieve a list of possible values for a field.

Script bamboo_hr Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
/**
3
 * Get Field Options
4
 * Use this resource to retrieve a list of possible values for a field.
5
 */
6
export async function main(auth: RT.BambooHr, datasetName: string, body: Body) {
7
	const url = new URL(
8
		`https://${auth.companyDomain}.bamboohr.com/api/v1/datasets/${datasetName}/field-options`
9
	)
10

11
	const response = await fetch(url, {
12
		method: 'POST',
13
		headers: {
14
			'Content-Type': 'application/json',
15
			Authorization: 'Basic ' + btoa(`${auth.apiKey}:x`)
16
		},
17
		body: JSON.stringify(body)
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

26
/* eslint-disable */
27
/**
28
 * This file was automatically generated by json-schema-to-typescript.
29
 * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
30
 * and run json-schema-to-typescript to regenerate this file.
31
 */
32

33
/**
34
 * Schema for field options request
35
 */
36
export interface Body {
37
	/**
38
	 * List of field names to get options for
39
	 */
40
	fields: string[]
41
	/**
42
	 * Dependent fields and their values that affect the options of the requested fields
43
	 */
44
	dependentFields?: {
45
		[k: string]: {
46
			field?: string
47
			value?: string
48
			[k: string]: unknown
49
		}[]
50
	} | null
51
	[k: string]: unknown
52
}
53