logo Windmill Hub
Login
All items

List Organizations

#### Pagination * Cursor pagination (recommended) * Offset pagination See Pagination. Returns a maximum of 100 records per page. #### Allowed For * Agents, with certain restrictions If the agent has a custom agent role that restricts their access to only users in their own organization, a 403 Forbidden error is returned. See [Creating custom agent roles](https://support.zendesk.com/hc/en-us/articles/203662026-Creating-custom-roles-and-assigning-agents#topic_cxn_hig_bd) in Zendesk help.

Script zendesk Verified

by hugo697 ยท 11/7/2023

Use in Windmill

The script

Submitted by hugo697 Typescript (fetch-only)
Verified 377 days ago
All edits
Permalink
1 
type Zendesk = {
2 
  username: string;
3 
  password: string;
4 
  subdomain: string;
5 
};
6 
/**
7 
 * List Organizations
8 
 * #### Pagination
9
10 
* Cursor pagination (recommended)
11 
* Offset pagination
12
13 
See Pagination.
14
15 
Returns a maximum of 100 records per page.
16
17 
#### Allowed For
18
19 
* Agents, with certain restrictions
20
21 
If the agent has a custom agent role that restricts their access to only users in their own organization, a 403 Forbidden error is returned. See [Creating custom agent roles](https://support.zendesk.com/hc/en-us/articles/203662026-Creating-custom-roles-and-assigning-agents#topic_cxn_hig_bd) in Zendesk help.
22
23 
 */
24 
export async function main(auth: Zendesk) {
25 
  const url = new URL(
26 
    `https://${auth.subdomain}.zendesk.com/api/v2/organizations`
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