0

ListCustomerGroups

by
Published Oct 17, 2025

Retrieves the list of customer groups of a business.

Script square Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Square = {
3
  token: string;
4
};
5
/**
6
 * ListCustomerGroups
7
 * Retrieves the list of customer groups of a business.
8
 */
9
export async function main(
10
  auth: Square,
11
  cursor: string | undefined,
12
  limit: string | undefined,
13
) {
14
  const url = new URL(`https://connect.squareup.com/v2/customers/groups`);
15
  for (const [k, v] of [
16
    ["cursor", cursor],
17
    ["limit", limit],
18
  ]) {
19
    if (v !== undefined && v !== "" && k !== undefined) {
20
      url.searchParams.append(k, v);
21
    }
22
  }
23
  const response = await fetch(url, {
24
    method: "GET",
25
    headers: {
26
      Authorization: "Bearer " + auth.token,
27
    },
28
    body: undefined,
29
  });
30
  if (!response.ok) {
31
    const text = await response.text();
32
    throw new Error(`${response.status} ${text}`);
33
  }
34
  return await response.json();
35
}
36