List Deleted Users

type Zendesk = {

  username: string;

  password: string;

  subdomain: string;

};

/**

 * List Deleted Users

 * Returns deleted users, including permanently deleted users.

If the results contains permanently deleted users, the users' properties

that normally contain personal data, such as `email` and `phone`,

are null. The `name` property is "Permanently Deleted User".

#### Pagination

* Cursor pagination (recommended)

* Offset pagination

See Pagination.

Returns a maximum of 100 records per page.

#### Allowed For

* Agents

 */

export async function main(auth: Zendesk) {

  const url = new URL(

    `https://${auth.subdomain}.zendesk.com/api/v2/deleted_users`

  );

  const response = await fetch(url, {

    method: "GET",

    headers: {

      Authorization: "Basic " + btoa(`${auth.username}:${auth.password}`),

    },

    body: undefined,

  });

  if (!response.ok) {

    const text = await response.text();

    throw new Error(`${response.status} ${text}`);

  }

  return await response.json();

}