STstacksync
App schema

Get an app schema

List the tables Stacksync can sync through a connection, with the primary key of each. Columns are not read by this route: use the generate app schema route with table_names to read them.

get/v1/workspaces/{workspace_id}/helpers/app-schema

Request

  • Base URL
    https://api.stacksync.com
  • URL
    https://api.stacksync.com/v1/workspaces/{workspace_id}/helpers/app-schema
  • Auth
    HTTP bearer

Path parameters

workspace_idinteger required

The workspace the resources belong to

Query parameters

region'besg' | 'usnv' required

Data region of the connection

connection_idstring uuid required

The connection to read the schema through; the user of the API key must have created it or it must be shared with the workspace

Response

The tables of the app

app_typestring required

The app of the connection, as shown in Stacksync

can_create_tablesboolean required

Whether a sync may create a new table in this app (table_options.create_new_table: true)

Changes

No recorded changes to this operation across all 1 revision of this API.