Show Custom Object Field

Returns a custom field for a specific object using a provided key or id of the field. #### 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
 * Show Custom Object Field
8
 * Returns a custom field for a specific object using a provided key or id of the field.
9
#### Allowed For
10
* Agents
11

12
 */
13
export async function main(
14
  auth: Zendesk,
15
  custom_object_key: string,
16
  custom_object_field_key_or_id: string
17
) {
18
  const url = new URL(
19
    `https://${auth.subdomain}.zendesk.com/api/v2/custom_objects/${custom_object_key}/fields/${custom_object_field_key_or_id}`
20
  );
21

22
  const response = await fetch(url, {
23
    method: "GET",
24
    headers: {
25
      Authorization: "Basic " + btoa(`${auth.username}:${auth.password}`),
26
    },
27
    body: undefined,
28
  });
29
  if (!response.ok) {
30
    const text = await response.text();
31
    throw new Error(`${response.status} ${text}`);
32
  }
33
  return await response.json();
34
}
35