0

Retrieve an organization by ID or slug

by
Published Apr 8, 2025

Fetches the organization whose ID or slug matches the provided `id_or_slug` URL query parameter.

Script clerk Verified

The script

Submitted by hugo697 Bun
Verified 428 days ago
1
//native
2
type Clerk = {
3
  apiKey: string;
4
};
5
/**
6
 * Retrieve an organization by ID or slug
7
 * Fetches the organization whose ID or slug matches the provided `id_or_slug` URL query parameter.
8
 */
9
export async function main(
10
  auth: Clerk,
11
  organization_id: string,
12
  include_members_count: string | undefined,
13
) {
14
  const url = new URL(
15
    `https://api.clerk.com/v1/organizations/${organization_id}`,
16
  );
17
  for (const [k, v] of [["include_members_count", include_members_count]]) {
18
    if (v !== undefined && v !== "" && k !== undefined) {
19
      url.searchParams.append(k, v);
20
    }
21
  }
22
  const response = await fetch(url, {
23
    method: "GET",
24
    headers: {
25
      Authorization: "Bearer " + auth.apiKey,
26
    },
27
    body: undefined,
28
  });
29
  if (!response.ok) {
30
    const text = await response.text();
31
    throw new Error(`${response.status} ${text}`);
32
  }
33
  return await response.json();
34
}
35