0

Get notes

by
Published Oct 17, 2025

Retrieves all [notes](https://help.kustomer.com/using-notes-HJvDjNP58) for a Kustomer organization. Any 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
7
 * Retrieves all [notes](https://help.kustomer.com/using-notes-HJvDjNP58) for a Kustomer organization.
8

9

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

12
|Legacy Role|Equivalent Permission Set Role|
13
|-----|--------|
14
|org.user.note.read|org.permission.note.read|
15
 */
16
export async function main(auth: Kustomer) {
17
  const url = new URL(`https://api.kustomerapp.com/v1/notes`);
18

19
  const response = await fetch(url, {
20
    method: "GET",
21
    headers: {
22
      Authorization: "Bearer " + auth.apiKey,
23
    },
24
    body: undefined,
25
  });
26
  if (!response.ok) {
27
    const text = await response.text();
28
    throw new Error(`${response.status} ${text}`);
29
  }
30
  return await response.json();
31
}
32