0

RetrieveBookingCustomAttributeDefinition

by
Published Oct 17, 2025

Retrieves a bookings custom attribute definition. To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope. To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.

Script square Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Square = {
3
  token: string;
4
};
5
/**
6
 * RetrieveBookingCustomAttributeDefinition
7
 * Retrieves a bookings custom attribute definition.
8

9
To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
10
To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
11
 */
12
export async function main(
13
  auth: Square,
14
  key: string,
15
  version: string | undefined,
16
) {
17
  const url = new URL(
18
    `https://connect.squareup.com/v2/bookings/custom-attribute-definitions/${key}`,
19
  );
20
  for (const [k, v] of [["version", version]]) {
21
    if (v !== undefined && v !== "" && k !== undefined) {
22
      url.searchParams.append(k, v);
23
    }
24
  }
25
  const response = await fetch(url, {
26
    method: "GET",
27
    headers: {
28
      Authorization: "Bearer " + auth.token,
29
    },
30
    body: undefined,
31
  });
32
  if (!response.ok) {
33
    const text = await response.text();
34
    throw new Error(`${response.status} ${text}`);
35
  }
36
  return await response.json();
37
}
38