PgBeam Docs
Support

getSupportCase

Get a support case

Returns a support case with all its messages.

Usage

const result = await api.support.getSupportCase({
  pathParams: { org_id: "org_abc123", case_id: "sc_xxx" },
});

Parameters

ParameterTypeRequiredDescription
pathParams.org_idstringYesUnique organization identifier.
pathParams.case_idstringYesUnique support case identifier (prefixed, e.g. sc_xxx).

Response

Promise<GetSupportCaseResponse> — support case with messages.

Example

import { PgBeamClient } from "pgbeam";

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

const result = await client.api.support.getSupportCase({
  pathParams: { org_id: "org_abc123", case_id: "sc_xxx" },
});

Errors

StatusDescription
400Invalid request parameters.
401Missing or invalid authentication.
403Operation not allowed by current plan limits.
404Resource not found.

On this page