Get companies

//native

type Kustomer = {

  apiKey: string;

};

/**

 * Get companies

 * Retrieves all companies. You can optionally filter this list by the company name or the unique external company ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role|

|-----|--------|

|org.user.company.read|org.permission.company.read|

### Note

> If you use both the `externalId` and `filter` query params, the request ignores both query params.

 */

export async function main(

  auth: Kustomer,

  externalId: string | undefined,

  filter: string | undefined,

) {

  const url = new URL(`https://api.kustomerapp.com/v1/companies`);

  for (const [k, v] of [

    ["externalId", externalId],

    ["filter", filter],

  ]) {

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

      url.searchParams.append(k, v);

    }

  }

  const response = await fetch(url, {

    method: "GET",

    headers: {

      Authorization: "Bearer " + auth.apiKey,

    },

    body: undefined,

  });

  if (!response.ok) {

    const text = await response.text();

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

  }

  return await response.json();

}