Apps & Surfaces
Apps
Explore the data types and operations available in Apps.
114 operations
Attach a team to a custom app. Requires customappteam:write permission.
attachCustomAppUserMutationAttach a user to a custom app. Requires customappuser:write permission.
closeDraftPreviewMutationEnd a draft preview now rather than at its idle timeout. Only the person who opened it may close it. Requires customapp:write.
compileSchemaXMLQueryCompile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.
createCustomAppMutationCreate a new custom app. Requires customapp:write permission.
createCustomAppSessionMutationCreate a session token for a custom app. The token should be passed in the X-App-Session header for RPC calls. Open to anyone who can see the app: customapp:read holders by the usual visibility rule, and other signed-in users for a published app assigned to them directly or through a team (as customAppView). Previewing a version needs customapp:read.
createCustomAppVersionMutationCreate a new version snapshot of a custom app. Requires customapp:write permission.
createCustomDataContainerMutationCreate a custom data container. Requires customapp:write permission.
createDashboardMutationCreate a new dashboard. Requires dashboard:write permission.
createDashboardCardMutationCreate a card on a dashboard. Only the dashboard owner may. Requires dashboard:write permission.
createDataClipMutationCreate a new data clip
createDataRecordMutationCreate a new data record. Requires datarecord:write permission.
createDataSchemaMutationCreate a new data schema. Requires dataschema:write permission.
createExternalSchemaMutationCreate a new external schema. Triggers background processing. Requires externalSchema:write permission.
createProtobufSchemaMutationCreate a new protobuf schema. Requires protobufSchema:write permission.
customAppViewQueryOne published custom app by handle, as customAppViews would list it (customapp:read in place of customapp:list); null when unknown, unpublished or not visible to the caller.
customAppViewsQueryThe published custom apps the caller may run. With customapp:list, every app visible to them; without it, the apps assigned to them directly or through one of their teams.
dataChangeEventsSubscriptionSubscribe to real-time data change events. Requires read permission on each requested resource. Task topics are the exception: a signed-in user without task:read receives the events of their own tasks only (assigned to them, claimed by them, unclaimed on their teams).
dataRecordsBySchemaQueryList data records for a schema with pagination. Requires datarecord:read permission.
dataRecordsByTaggableQueryList data records tagged to a specific entity with pagination. Requires datarecord:read permission.
dataSchemasQueryList all data schemas for the current tenant with pagination. Requires dataschema:read permission.
deleteAPIClientDefinitionMutationDelete an API definition only when its current revision matches.
deleteCustomAppMutationDelete a custom app. Requires customapp:delete permission.
deleteCustomAppVersionMutationDelete a custom app version. Requires customapp:delete permission.
deleteCustomDataContainerMutationDelete a custom data container. Requires customapp:delete permission.
deleteDashboardMutationDelete a dashboard and all its cards. Requires dashboard:delete permission.
deleteDashboardCardMutationDelete a card from a dashboard. Requires dashboard:write permission.
deleteDataClipMutationDelete a data clip
deleteDataRecordMutationDelete a data record. Requires datarecord:delete permission.
deleteDataSchemaMutationDelete a data schema. Requires dataschema:delete permission.
deleteExternalSchemaMutationDelete an external schema and all its entries. Requires externalSchema:delete permission.
deleteProtobufSchemaMutationDelete a protobuf schema. Requires protobufSchema:delete permission.
detachCustomAppTeamMutationDetach a team from a custom app. Requires customappteam:write permission.
detachCustomAppUserMutationDetach a user from a custom app. Requires customappuser:write permission.
exportDashboardMutationExport a dashboard and its cards to YAML or JSON. Requires dashboard:read permission.
generateDefaultDataQueryQueryGenerate a default GraphQL data query for an event topic. Returns a query string with all scalar fields for the resource, or null if the topic has no matching query. The query uses $id as the variable for the resource ID.
getAPIClientDefinitionQueryRead a tenant API definition and its current compilation status.
getCustomAppQueryFetch a custom app by ID. Requires customapp:read permission.
getCustomAppByHandleQueryFetch a custom app by handle. Requires customapp:read permission.
getCustomAppVersionQueryFetch a custom app version by ID. Requires customapp:read permission.
getCustomDataContainerQueryFetch a custom data container by ID. Requires customapp:read permission.
getDashboardQueryFetch a dashboard by ID with its cards. Requires dashboard:read permission.
getDashboardCardQueryFetch a single dashboard card. Visibility follows the parent dashboard. Requires dashboard:read permission.
getDataClipQueryGet a data clip by ID
getDataRecordQueryFetch a data record by ID. Requires datarecord:read permission.
getDataSchemaQueryFetch a data schema by ID. Requires dataschema:read permission.
getDataSchemaByNameQueryFetch a data schema by name. Requires dataschema:read permission.
getExternalSchemaQueryFetch an external schema by ID. Requires externalSchema:read permission.
getMagicQueryGraphQLQueryResolves a Magic Query string to the real GraphQL operation and variables it runs, so consumers can graduate from the façade to raw GraphQL. Does not execute.
getMagicQuerySchemaQueryReturns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.