0

Get conversation by external ID

by
Published Oct 17, 2025

Retrieves a single conversation based on a unique external ID. 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 conversation by external ID
7
 * Retrieves a single conversation based on a unique external ID.
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(auth: Kustomer, externalId: string) {
16
  const url = new URL(
17
    `https://api.kustomerapp.com/v1/conversations/externalId=${externalId}`,
18
  );
19

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