getDataPlan
Client function: get the saved mongoCollections schema (data plan) for a site.
import { getDataPlan } from 'flowstack-sdk'Non-React client function. GET /api/v1/sites/{siteId}/data-plan.
Signature
getDataPlan(credentials, siteId, config?): Promise<ApiResponse<DataPlan>>Parameters
| Param | Type | Notes | Description |
|---|---|---|---|
credentials | FlowstackCredentials | required | The app owner's credentials (owner-scoped JWT). |
siteId | string | required | The site/app id to operate on. |
config | FlowstackClientConfig | since 0.2.7 | Client config (baseUrl, appScope, tenantId as needed). |
Returns
| Field | Type | Description |
|---|---|---|
| — | Promise<ApiResponse<DataPlan>> | The stored DataPlan (its mongoCollections schema). |
Examples
Read the data plan
const res = await getDataPlan(credentials, siteId, { appScope });WarningOwner/management operation — call it with the app owner's credentials from a builder/dashboard/server context, not from inside the generated app's end-user runtime.
builtAppSafe is false.See also
Source: src/api/client.ts (Site Ops, P0-156) · Also available in llms-full.txt and registry.json.