Search Tags

type Zendesk = {

  username: string;

  password: string;

  subdomain: string;

};

/**

 * Search Tags

 * Returns an array of registered and recent tag names that start with the characters specified in the `name` query parameter. You must specify at least 2 characters.

#### Pagination

* Offset pagination only

See Using Offset Pagination.

#### Allowed For

* Agents

 */

export async function main(auth: Zendesk, name: string | undefined) {

  const url = new URL(

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

  );

  for (const [k, v] of [["name", name]]) {

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

}