Apps & Surfaces

Apps

Explore the data types and operations available in Apps.

114 operations

attachCustomAppTeamMutation

Attach a team to a custom app. Requires customappteam:write permission.

attachCustomAppUserMutation

Attach a user to a custom app. Requires customappuser:write permission.

closeDraftPreviewMutation

End a draft preview now rather than at its idle timeout. Only the person who opened it may close it. Requires customapp:write.

compileSchemaXMLQuery

Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.

createCustomAppMutation

Create a new custom app. Requires customapp:write permission.

createCustomAppSessionMutation

Create 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.

createCustomAppVersionMutation

Create a new version snapshot of a custom app. Requires customapp:write permission.

createCustomDataContainerMutation

Create a custom data container. Requires customapp:write permission.

createDashboardMutation

Create a new dashboard. Requires dashboard:write permission.

createDashboardCardMutation

Create a card on a dashboard. Only the dashboard owner may. Requires dashboard:write permission.

createDataClipMutation

Create a new data clip

createDataRecordMutation

Create a new data record. Requires datarecord:write permission.

createDataSchemaMutation

Create a new data schema. Requires dataschema:write permission.

createExternalSchemaMutation

Create a new external schema. Triggers background processing. Requires externalSchema:write permission.

createProtobufSchemaMutation

Create a new protobuf schema. Requires protobufSchema:write permission.

customAppViewQuery

One 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.

customAppViewsQuery

The 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.

dataChangeEventsSubscription

Subscribe 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).

dataRecordsBySchemaQuery

List data records for a schema with pagination. Requires datarecord:read permission.

dataRecordsByTaggableQuery

List data records tagged to a specific entity with pagination. Requires datarecord:read permission.

dataSchemasQuery

List all data schemas for the current tenant with pagination. Requires dataschema:read permission.

deleteAPIClientDefinitionMutation

Delete an API definition only when its current revision matches.

deleteCustomAppMutation

Delete a custom app. Requires customapp:delete permission.

deleteCustomAppVersionMutation

Delete a custom app version. Requires customapp:delete permission.

deleteCustomDataContainerMutation

Delete a custom data container. Requires customapp:delete permission.

deleteDashboardMutation

Delete a dashboard and all its cards. Requires dashboard:delete permission.

deleteDashboardCardMutation

Delete a card from a dashboard. Requires dashboard:write permission.

deleteDataClipMutation

Delete a data clip

deleteDataRecordMutation

Delete a data record. Requires datarecord:delete permission.

deleteDataSchemaMutation

Delete a data schema. Requires dataschema:delete permission.

deleteExternalSchemaMutation

Delete an external schema and all its entries. Requires externalSchema:delete permission.

deleteProtobufSchemaMutation

Delete a protobuf schema. Requires protobufSchema:delete permission.

detachCustomAppTeamMutation

Detach a team from a custom app. Requires customappteam:write permission.

detachCustomAppUserMutation

Detach a user from a custom app. Requires customappuser:write permission.

exportDashboardMutation

Export a dashboard and its cards to YAML or JSON. Requires dashboard:read permission.

generateDefaultDataQueryQuery

Generate 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.

getAPIClientDefinitionQuery

Read a tenant API definition and its current compilation status.

getCustomAppQuery

Fetch a custom app by ID. Requires customapp:read permission.

getCustomAppByHandleQuery

Fetch a custom app by handle. Requires customapp:read permission.

getCustomAppVersionQuery

Fetch a custom app version by ID. Requires customapp:read permission.

getCustomDataContainerQuery

Fetch a custom data container by ID. Requires customapp:read permission.

getDashboardQuery

Fetch a dashboard by ID with its cards. Requires dashboard:read permission.

getDashboardCardQuery

Fetch a single dashboard card. Visibility follows the parent dashboard. Requires dashboard:read permission.

getDataClipQuery

Get a data clip by ID

getDataRecordQuery

Fetch a data record by ID. Requires datarecord:read permission.

getDataSchemaQuery

Fetch a data schema by ID. Requires dataschema:read permission.

getDataSchemaByNameQuery

Fetch a data schema by name. Requires dataschema:read permission.

getExternalSchemaQuery

Fetch an external schema by ID. Requires externalSchema:read permission.

getMagicQueryGraphQLQuery

Resolves 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.

getMagicQuerySchemaQuery

Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.