0

List all clients

by
Published Apr 8, 2025

Returns a list of all clients. The clients are returned sorted by creation date, with the newest clients appearing first. Warning: the endpoint is being deprecated and will be removed in future versions.

Script clerk Verified

The script

Submitted by hugo697 Bun
Verified 428 days ago
1
//native
2
type Clerk = {
3
  apiKey: string;
4
};
5
/**
6
 * List all clients
7
 * Returns a list of all clients. The clients are returned sorted by creation date,
8
with the newest clients appearing first.
9
Warning: the endpoint is being deprecated and will be removed in future versions.
10
 */
11
export async function main(
12
  auth: Clerk,
13
  limit: string | undefined,
14
  offset: string | undefined,
15
) {
16
  const url = new URL(`https://api.clerk.com/v1/clients`);
17
  for (const [k, v] of [
18
    ["limit", limit],
19
    ["offset", offset],
20
  ]) {
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.apiKey,
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