0

Get notes by customer ID

by
Published Oct 17, 2025

Retrieves notes for a specific customer based on the unique customer ID. [Notes](https://help.kustomer.com/using-notes-HJvDjNP58) are internal communications visible only to users in your Kustomer organization. Any one of the following roles is required for this endpoint: |Legacy Role|Equivalent Permission Set Role| |-----|--------| |org.user.note.read|org.permission.note.read|

Script kustomer Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Kustomer = {
3
  apiKey: string;
4
};
5
/**
6
 * Get notes by customer ID
7
 * Retrieves notes for a specific customer based on the unique customer ID.
8

9
[Notes](https://help.kustomer.com/using-notes-HJvDjNP58) are internal communications visible only to users in your Kustomer organization.
10

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

13
|Legacy Role|Equivalent Permission Set Role|
14
|-----|--------|
15
|org.user.note.read|org.permission.note.read|
16
 */
17
export async function main(
18
  auth: Kustomer,
19
  id: string,
20
  page: string | undefined,
21
  pageSize: string | undefined,
22
) {
23
  const url = new URL(`https://api.kustomerapp.com/v1/customers/${id}/notes`);
24
  for (const [k, v] of [
25
    ["page", page],
26
    ["pageSize", pageSize],
27
  ]) {
28
    if (v !== undefined && v !== "" && k !== undefined) {
29
      url.searchParams.append(k, v);
30
    }
31
  }
32
  const response = await fetch(url, {
33
    method: "GET",
34
    headers: {
35
      Authorization: "Bearer " + auth.apiKey,
36
    },
37
    body: undefined,
38
  });
39
  if (!response.ok) {
40
    const text = await response.text();
41
    throw new Error(`${response.status} ${text}`);
42
  }
43
  return await response.json();
44
}
45