App Data SDK

Setup in the dashboard: App Data guide

App Data exposes custom database tables defined in your project dashboard. Requires the App Data feature (app_data) — Growth plan and above. Access per table is configured in the dashboard (e.g. public read, authenticated write). The SDK respects those presets; unauthorized calls return API errors.

getDataModels()

List tables (models) available to the current visitor.

const models = await window.webstorio.getDataModels();
// [{ key, name, fields, apiAccess, ... }]

Call this first to discover valid modelKey values and field schemas.

listRecords(modelKey, options?)

const result = await window.webstorio.listRecords("directory", {
  limit: 50,
  offset: 0,
  filters: [
    { field: "status", value: "open" },
    { field: "city", value: "Jakarta" },
  ],
  // or single: filterField: "status", filterValue: "open"
  search: "coffee",
  searchField: "name", // optional — field key to search
  sort: [
    { field: "priority", direction: "desc" },
    { field: "name", direction: "asc" },
  ],
  // or: sort: "priority:desc,name:asc"
});

// { records: [{ id, dataJson, ... }], total, limit, offset, sort, filters? }

filters are optional exact-match AND conditions (up to 5). Prefer filters: [{ field, value }] for multiple fields; filterField + filterValue still works for a single field. On the public API, only API-exposed fields are allowed. sort is optional. When omitted, the table’s dashboard default sort applies (updatedAt desc if unset). You can sort by schema field keys plus createdAt / updatedAt (up to 5 fields). Direction defaults to asc when omitted.

getRecord(modelKey, recordId)

const { content_entry_id } = window.webstorio.getPathParams();
const record = await window.webstorio.getRecord("directory", recordId);

Use on detail pages with dynamic slugs or when you have an ID from a list.

createRecord(modelKey, dataJson)

await window.webstorio.createRecord("waitlist", {
  email: "[email protected]",
  name: "Alex",
});

Typically requires signed-in visitor or public-write preset.

updateRecord(modelKey, recordId, dataJson)

await window.webstorio.updateRecord("inventory", recordId, {
  quantity: 42,
});

deleteRecord(modelKey, recordId)

await window.webstorio.deleteRecord("inventory", recordId);

Field types

Each column in schemaJson is { key, type, label, required?, unique?, validation?, default?, api? }. Values in dataJson match the field type:

Type	Label	Stored value
`text`	Short text	string
`longtext`	Long text	string
`number`	Number	number
`boolean`	Yes / no	boolean
`date`	Date	string (`YYYY-MM-DD`)
`url`	Link	string
`email`	Email	string
`image`	Image	string (asset URL)
`video`	Video	string (asset URL)
`document`	Document	string (asset URL)
`select`	Dropdown	string (option value)
`multiselect`	Multi-select	string[]
`json`	JSON	object

validation may include minLength, maxLength, min, max, pattern, and options ({ value, label }[]) for select / multiselect. image, video, and document store a public asset URL — upload files in Assets and pick them in the row editor.

Schema validation

dataJson must match the table schema defined in the dashboard. Invalid fields or types are rejected with validation errors.

Dashboard configuration

Configure tables under Project → Data (or App Data). Set field types, validation, and API access presets before calling SDK methods from generated pages.

Overview

CLI

Client SDK

MCP Server

Help

getDataModels()

listRecords(modelKey, options?)

getRecord(modelKey, recordId)

createRecord(modelKey, dataJson)

updateRecord(modelKey, recordId, dataJson)

deleteRecord(modelKey, recordId)

Field types

Schema validation

Dashboard configuration

​getDataModels()

​listRecords(modelKey, options?)

​getRecord(modelKey, recordId)

​createRecord(modelKey, dataJson)

​updateRecord(modelKey, recordId, dataJson)

​deleteRecord(modelKey, recordId)

​Field types

​Schema validation

​Dashboard configuration

getDataModels()

listRecords(modelKey, options?)

getRecord(modelKey, recordId)

createRecord(modelKey, dataJson)

updateRecord(modelKey, recordId, dataJson)

deleteRecord(modelKey, recordId)

Field types

Schema validation

Dashboard configuration