Search Users

type Zendesk = {

  username: string;

  password: string;

  subdomain: string;

};

/**

 * Search Users

 * Returns an array of users who meet the search criteria.

#### Pagination

* Offset pagination only

See Using Offset Pagination.

#### Allowed For

* Admins, Agents and Light Agents

 */

export async function main(

  auth: Zendesk,

  query: string | undefined,

  external_id: string | undefined

) {

  const url = new URL(

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

  );

  for (const [k, v] of [

    ["query", query],

    ["external_id", external_id],

  ]) {

    if (v !== undefined && v !== "") {

      url.searchParams.append(k, v);

    }

  }

  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();

}