getSeo
Client function: read a site's builder-set SEO configuration.
import { getSeo } from 'flowstack-sdk'Non-React client function. GET /api/v1/sites/{siteId}/seo. Returns the AppSeo block the builder has stored for the app — description, keywords, OG image, FAQ entries and structured-data type.
Signature
getSeo(credentials, siteId, config?): Promise<ApiResponse<{ site_id: string; seo: AppSeo }>>Parameters
| Param | Type | Notes | Description |
|---|---|---|---|
credentials | FlowstackCredentials | required | The app owner's credentials (owner-scoped JWT). |
siteId | string | required | The site/app id to read. |
config | FlowstackClientConfig | — | Client config (baseUrl, tenantId as needed). |
Returns
| Field | Type | Description |
|---|---|---|
| — | Promise<ApiResponse<{ site_id: string; seo: AppSeo }>> | The stored AppSeo config. Fields are all optional — an unconfigured site returns an empty object. |
Examples
Read SEO config
const res = await getSeo(credentials, siteId);
if (res.ok) console.log(res.data.seo.description);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 (Builder SEO, P0-176) · Also available in llms-full.txt and registry.json.