0

BulkRetrieveCustomers

by
Published Oct 17, 2025

Retrieves multiple customer profiles. This endpoint takes a list of customer IDs and returns a map of responses.

Script square Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Square = {
3
  token: string;
4
};
5
/**
6
 * BulkRetrieveCustomers
7
 * Retrieves multiple customer profiles.
8

9
This endpoint takes a list of customer IDs and returns a map of responses.
10
 */
11
export async function main(auth: Square, body: { customer_ids: string[] }) {
12
  const url = new URL(
13
    `https://connect.squareup.com/v2/customers/bulk-retrieve`,
14
  );
15

16
  const response = await fetch(url, {
17
    method: "POST",
18
    headers: {
19
      "Content-Type": "application/json",
20
      Authorization: "Bearer " + auth.token,
21
    },
22
    body: JSON.stringify(body),
23
  });
24
  if (!response.ok) {
25
    const text = await response.text();
26
    throw new Error(`${response.status} ${text}`);
27
  }
28
  return await response.json();
29
}
30