Apps & Surfaces
Apps
Explore the data types and operations available in Apps.
163 types · Used in operation arguments and return values.
Persisted API contract and its revision-bound Lua type export.
APIClientDefinitionConnectionObjectPaginated API client definitions.
APIClientDefinitionIDScalarTenant API client definition identity.
APIClientDefinitionInputInputExternal schema reference and exactly one native or DataXML definition.
AttachCustomAppTeamInputInputInput for attaching a team to a custom app
AttachCustomAppTeamPayloadObjectResult of attaching a team to a custom app
AttachCustomAppUserInputInputInput for attaching a user to a custom app
AttachCustomAppUserPayloadObjectResult of attaching a user to a custom app
CloseDraftPreviewPayloadObjectResult of closing a draft preview.
CreateCustomAppInputInputInput for creating a custom app
CreateCustomAppSessionInputInputInput for creating a custom app session
CreateCustomAppVersionInputInputInput for restoring a custom app to a specific version
CreateCustomAppVersionPayloadObjectResult of restoring a custom app to a version
CreateCustomDataContainerInputInputInput for creating a custom data container
CreateDashboardCardInputInputFields for creating a dashboard card
CreateDashboardInputInputInput for creating a dashboard
CreateDataClipInputInputInput for `createDataClip`. The creator, share token and timestamps are assigned server-side.
CreateDataRecordInputInputInput for creating a data record
CreateDataSchemaInputInputInput for creating a data schema
CreateExternalSchemaInputInputInput for creating an external schema
CreateProtobufSchemaInputInputInput for creating a protobuf schema
CustomAppConnectionObjectPaginated list of custom apps
CustomAppDraftInputInputA custom app's draft, as far as its preview needs it.
CustomAppFilterInputInputFilter input for custom app queries
CustomAppIDScalarUnique identifier for a custom app
CustomAppSessionObjectA session token for custom app RPC and GraphQL calls
CustomAppSortInputInputSort input for custom app queries
CustomAppStateObjectA custom app with embedded Vue components
CustomAppTeamConnectionObjectPaginated list of custom app team bindings
CustomAppTeamFilterInputInputFilter input for custom app team bindings
CustomAppUserConnectionObjectPaginated list of custom app user bindings
CustomAppUserFilterInputInputFilter input for custom app user bindings
CustomAppVersionConnectionObjectPaginated list of custom app versions
CustomAppVersionFilterInputInputFilter input for custom app version queries
CustomAppVersionIDScalarUnique identifier for a custom app version
CustomAppVersionSortInputInputSort input for custom app version queries
CustomAppVersionStateObjectAn immutable snapshot of a custom app at a specific version
CustomAppViewObjectA published custom app as the app runtime reads it: no server source, drafts or data container spec. Authoring uses the CustomApp type.
CustomAppViewConnectionObjectA page of custom app views, ordered by name.
CustomDataContainerByIdInputInputInput for fetching a container by ID
CustomDataContainerConnectionObjectPaginated list of custom data containers
CustomDataContainerIDScalarUnique identifier for a custom data container
CustomDataContainersByAppInputInputInput for querying containers by app
CustomDataContainersByTaggableInputInputInput for querying containers by taggable entity
CustomDataContainerStateObjectA custom data container storing arbitrary JSON data
DashboardCardIDScalarUnique identifier for a dashboard card
DashboardCardStateObjectA card within a dashboard — one metric, chart, table, block of markdown, or embedded custom app. Cards display; they take no actions.
DashboardConnectionObjectPaginated list of dashboards
DashboardFilterInputInputFilter input for dashboard queries
DashboardIDScalarUnique identifier for a dashboard