PgBeam Docs
Platform

listSelfHostEnrollments

List self-host enrollments

Lists an organization's self-host enrollments. Tokens are never returned.

Usage

const result = await api.platform.listSelfHostEnrollments({
  pathParams: { org_id: "org_abc123" },
});

Parameters

ParameterTypeRequiredDescription
pathParams.org_idstringYesUnique organization identifier.

Response

Promise<ListSelfHostEnrollmentsResponse>: list of enrollments.

Example

import { PgBeamClient } from "pgbeam";

const client = new PgBeamClient({
  token: "pbk_...",
  baseUrl: "https://api.pgbeam.com",
});

const result = await client.api.platform.listSelfHostEnrollments({
  pathParams: { org_id: "org_abc123" },
});

Errors

StatusDescription
401Missing or invalid authentication.
403Operation not allowed by current plan limits.

On this page