Apps & Surfaces

Surfaces

Explore the data types and operations available in Surfaces.

104 types · Used in operation arguments and return values.

PortalConnectionObject

A page of Portals.

PortalDomainObject

A custom domain alias reserved for a Portal. The generated hostname always remains available alongside it.

PortalDomainIDScalar

Typed identifier of a Portal custom-domain alias, serialized as a `pdm_` TypeID string.

PortalDomainPayloadObject

Result of a custom domain alias mutation.

PortalIDScalar

Typed identifier of a Portal, serialized as a `por_` TypeID string.

PortalLoginTicketObject

A single-use, short-lived bearer that starts a Portal browser session. Its secret is returned only at issuance.

PortalLoginTicketConnectionObject

A page of login tickets.

PortalLoginTicketIDScalar

Typed identifier of a Portal login ticket, serialized as a `pot_` TypeID string.

PortalLoginTicketPayloadObject

Result of a login ticket mutation.

PortalMembershipObject

Connects a PortalUser to a customer within one Portal.

PortalMembershipConnectionObject

A page of memberships.

PortalMembershipIDScalar

Typed identifier of a PortalMembership, serialized as a `pom_` TypeID string.

PortalMembershipPayloadObject

Result of a membership mutation.

PortalPartKindEnum

Which part a `.portal` file holds.

PortalPayloadObject

Result of a Portal mutation.

PortalSiteObject

One site of a Portal. It serves whichever immutable source version is published.

PortalSiteConnectionObject

A page of sites.

PortalSiteDocumentObject

A site version's source read as typed parts. Part order is the document's.

PortalSiteIDScalar

Typed identifier of a PortalSite, serialized as a `pos_` TypeID string.

PortalSitePayloadObject

Result of a site mutation.

PortalSiteVersionObject

An immutable source snapshot of a site. Publishing one makes it the served version; publishing an older one rolls back.

PortalSiteVersionConnectionObject

A page of site versions.

PortalSiteVersionIDScalar

Typed identifier of an immutable PortalSiteVersion snapshot, serialized as a `psv_` TypeID string.

PortalSiteVersionPayloadObject

Result of a site version mutation.

PortalUserObject

A person who signs in to Portals. PortalUsers are tenant-wide and distinct from internal Users.

PortalUserConnectionObject

A page of PortalUsers.

PortalUserIDScalar

Typed identifier of a PortalUser, serialized as a `pou_` TypeID string.

PortalUserPayloadObject

Result of a PortalUser mutation.

QueryScalarScalar

A URI-style string defining an entity, optional ID, and filter parameters. Format: <noun>[#<id>][?<key>=<value>,...]. Examples: 'jobs?limit=100,status=approved', 'job#01H...'.

ReservePortalDomainInputInput

A custom domain alias to reserve for a Portal.

StringScalar

The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

UpdateJourneyInputInput

Patch input for `updateJourney` — every field is optional and an omitted field leaves that aspect of the journey unchanged. The journey is identified by the mutation's `id` argument, not by this input.

UpdateJourneySourceInputInput

Revision-checked edit of journey XML, scope or team assignments using native validation and authorization.

UpdatePortalInputInput

Patch for a Portal. Omitted fields keep their current values.

UpdatePortalMembershipInputInput

Patch for a membership. Omitted fields keep their current values.

UpdatePortalSiteInputInput

Patch for a site. Omitted fields keep their current values.

UpdatePortalUserInputInput

Patch for a PortalUser. Omitted fields keep their current values.

UpdateWorkspaceInputInput

Input for updating a workspace. Only provided fields are changed.

UpsertJourneyInputInput

Authoring input for `upsertJourney`: create a journey, or overwrite the open draft of the journey whose handle matches the definition's `id`.

UpsertWorkspaceInputInput

Input for `upsertWorkspace`: create a workspace or overwrite its open draft, keyed on the workspace id inside sourceXML.

ValidateSurfacePayloadObject

Result of a standalone surface-definition validation (journey or workspace), without persisting.

WorkspaceObject

An instance-served workspace: the container record joined with the relevant version's definition (the published version when published, else the open draft). A workspace is the standing surface a role works in — panels of live data plus one-tap actions that run mutations as the signed-in user. For a technical team's own monitoring board, with no actions, use a Dashboard instead.

WorkspaceAuthoringAnalysisObject

Execution-free analysis of Workspace XML and server Lua for authoring tools.

WorkspaceConnectionObject

A paginated, cursor-based page of workspaces returned by `listWorkspaces`.

WorkspaceFilterInputInput

Filter for `listWorkspaces`. All supplied criteria must match (AND).

WorkspaceIDScalar

Unique identifier for a workspace

WorkspacePayloadObject

Result of a workspace mutation: the workspace on success, or field-level validation errors.

WorkspaceSortInputInput

One ordering term for `listWorkspaces`. Only the first term is applied; the default is UPDATED_AT / DESC.

WorkspaceVersionObject

One immutable version of a workspace's definition. Versions form the authoring history; `listWorkspaceVersions` returns them newest first.

WorkspaceVersionConnectionObject

A page of a workspace's authoring history returned by `listWorkspaceVersions`.