0

Get conversations

by
Published Oct 17, 2025

Retrieves a paginated list of conversations for the organization. Any one of the following roles is required for this endpoint: |Legacy Role|Equivalent Permission Set Role| |-----|--------| |org.user.conversation.read|org.permission.conversation.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 conversations
7
 * Retrieves a paginated list of conversations for the organization.
8

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

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