Apps & Surfaces

Apps

Explore the data types and operations available in Apps.

163 types · Used in operation arguments and return values.

APIClientDefinitionObject

Persisted API contract and its revision-bound Lua type export.

APIClientDefinitionConnectionObject

Paginated API client definitions.

APIClientDefinitionIDScalar

Tenant API client definition identity.

APIClientDefinitionInputInput

External schema reference and exactly one native or DataXML definition.

AttachCustomAppTeamInputInput

Input for attaching a team to a custom app

AttachCustomAppTeamPayloadObject

Result of attaching a team to a custom app

AttachCustomAppUserInputInput

Input for attaching a user to a custom app

AttachCustomAppUserPayloadObject

Result of attaching a user to a custom app

CloseDraftPreviewPayloadObject

Result of closing a draft preview.

CreateCustomAppInputInput

Input for creating a custom app

CreateCustomAppSessionInputInput

Input for creating a custom app session

CreateCustomAppVersionInputInput

Input for restoring a custom app to a specific version

CreateCustomAppVersionPayloadObject

Result of restoring a custom app to a version

CreateCustomDataContainerInputInput

Input for creating a custom data container

CreateDashboardCardInputInput

Fields for creating a dashboard card

CreateDashboardInputInput

Input for creating a dashboard

CreateDataClipInputInput

Input for `createDataClip`. The creator, share token and timestamps are assigned server-side.

CreateDataRecordInputInput

Input for creating a data record

CreateDataSchemaInputInput

Input for creating a data schema

CreateExternalSchemaInputInput

Input for creating an external schema

CreateProtobufSchemaInputInput

Input for creating a protobuf schema

CustomAppConnectionObject

Paginated list of custom apps

CustomAppDraftInputInput

A custom app's draft, as far as its preview needs it.

CustomAppFilterInputInput

Filter input for custom app queries

CustomAppIDScalar

Unique identifier for a custom app

CustomAppSessionObject

A session token for custom app RPC and GraphQL calls

CustomAppSortInputInput

Sort input for custom app queries

CustomAppStateObject

A custom app with embedded Vue components

CustomAppTeamConnectionObject

Paginated list of custom app team bindings

CustomAppTeamFilterInputInput

Filter input for custom app team bindings

CustomAppUserConnectionObject

Paginated list of custom app user bindings

CustomAppUserFilterInputInput

Filter input for custom app user bindings

CustomAppVersionConnectionObject

Paginated list of custom app versions

CustomAppVersionFilterInputInput

Filter input for custom app version queries

CustomAppVersionIDScalar

Unique identifier for a custom app version

CustomAppVersionSortInputInput

Sort input for custom app version queries

CustomAppVersionStateObject

An immutable snapshot of a custom app at a specific version

CustomAppViewObject

A published custom app as the app runtime reads it: no server source, drafts or data container spec. Authoring uses the CustomApp type.

CustomAppViewConnectionObject

A page of custom app views, ordered by name.

CustomDataContainerByIdInputInput

Input for fetching a container by ID

CustomDataContainerConnectionObject

Paginated list of custom data containers

CustomDataContainerIDScalar

Unique identifier for a custom data container

CustomDataContainersByAppInputInput

Input for querying containers by app

CustomDataContainersByTaggableInputInput

Input for querying containers by taggable entity

CustomDataContainerStateObject

A custom data container storing arbitrary JSON data

DashboardCardIDScalar

Unique identifier for a dashboard card

DashboardCardStateObject

A card within a dashboard — one metric, chart, table, block of markdown, or embedded custom app. Cards display; they take no actions.

DashboardConnectionObject

Paginated list of dashboards

DashboardFilterInputInput

Filter input for dashboard queries

DashboardIDScalar

Unique identifier for a dashboard