Back to API Overview

Installed Apps API

List the internal apps installed for the account and the resources each one owns.

2 endpoints

Endpoints

POST
/api/v1/workspaceAppData/list

Internal apps installed for this account (for example the CRM), one page: { installs, nextCursor } (params: limit? 1..100, cursor? = nextCursor of the page before). For each: key, version, and how many tables, fields, views and flows each one owns, split by manageability (upgradeable = the app may change it on upgrade; subscriber_editable = the user changed it, upgrades leave it alone; locked = cannot be changed or deleted). Call this before editing a base that an app created. When an installed app lists an action that does the job (for example its set-up or add actions), run that action; do not write the app's own tables directly with the generic table tools, and never invent starting data the app already declares. If you are unsure which action, list the app's actions first.

Parameters

limitinteger

Page size, 1..100 (default 100)

cursorstring

nextCursor from the page before (omit for the first page)

Example Request

curl -X POST https://app.serenitiesai.com/api/v1/workspaceAppData/list \
  -H "Authorization: Bearer mk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "limit": {},
  "cursor": "example"
}'
POST
/api/v1/workspaceAppData/resources

The tables, fields, views, flows and other resources one installed app owns, one page: { app, resources, nextCursor } (params: appKey, limit? 1..100, cursor?), each with its stable key ("field:Contacts.Email"), manageability and when the user last edited it. Locked resources are refused server-side on change or delete, so add your own field next to a locked one instead. When an installed app lists an action that does the job (for example its set-up or add actions), run that action; do not write the app's own tables directly with the generic table tools, and never invent starting data the app already declares. If you are unsure which action, list the app's actions first.

Parameters

appKeystringrequired

App key from list, e.g. "crm"

limitinteger

Page size, 1..100 (default 100)

cursorstring

nextCursor from the page before (omit for the first page)

Example Request

curl -X POST https://app.serenitiesai.com/api/v1/workspaceAppData/resources \
  -H "Authorization: Bearer mk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "appKey": "example",
  "limit": {},
  "cursor": "example"
}'