List User Field Options

Returns a list of custom user field options for the given dropdown user field. #### Pagination * Cursor pagination (recommended) * Offset pagination See Pagination. Returns a maximum of 100 records per page. #### Allowed For * Agents

Script zendesk Verified

by hugo697 ยท 11/7/2023

The script

Submitted by hugo697 Typescript (fetch-only)
Verified 377 days ago
1
type Zendesk = {
2
  username: string;
3
  password: string;
4
  subdomain: string;
5
};
6
/**
7
 * List User Field Options
8
 * Returns a list of custom user field options for the given dropdown user field.
9

10
#### Pagination
11

12
* Cursor pagination (recommended)
13
* Offset pagination
14

15
See Pagination.
16

17
Returns a maximum of 100 records per page.
18

19
#### Allowed For
20

21
* Agents
22

23
 */
24
export async function main(auth: Zendesk, user_field_id: string) {
25
  const url = new URL(
26
    `https://${auth.subdomain}.zendesk.com/api/v2/user_fields/${user_field_id}/options`
27
  );
28

29
  const response = await fetch(url, {
30
    method: "GET",
31
    headers: {
32
      Authorization: "Basic " + btoa(`${auth.username}:${auth.password}`),
33
    },
34
    body: undefined,
35
  });
36
  if (!response.ok) {
37
    const text = await response.text();
38
    throw new Error(`${response.status} ${text}`);
39
  }
40
  return await response.json();
41
}
42