Apps & Surfaces
Surfaces
Explore the data types and operations available in Surfaces.
104 types · Used in operation arguments and return values.
A page of Portals.
PortalDomainObjectA custom domain alias reserved for a Portal. The generated hostname always remains available alongside it.
PortalDomainIDScalarTyped identifier of a Portal custom-domain alias, serialized as a `pdm_` TypeID string.
PortalDomainPayloadObjectResult of a custom domain alias mutation.
PortalIDScalarTyped identifier of a Portal, serialized as a `por_` TypeID string.
PortalLoginTicketObjectA single-use, short-lived bearer that starts a Portal browser session. Its secret is returned only at issuance.
PortalLoginTicketConnectionObjectA page of login tickets.
PortalLoginTicketIDScalarTyped identifier of a Portal login ticket, serialized as a `pot_` TypeID string.
PortalLoginTicketPayloadObjectResult of a login ticket mutation.
PortalMembershipObjectConnects a PortalUser to a customer within one Portal.
PortalMembershipConnectionObjectA page of memberships.
PortalMembershipIDScalarTyped identifier of a PortalMembership, serialized as a `pom_` TypeID string.
PortalMembershipPayloadObjectResult of a membership mutation.
PortalPartKindEnumWhich part a `.portal` file holds.
PortalPayloadObjectResult of a Portal mutation.
PortalSiteObjectOne site of a Portal. It serves whichever immutable source version is published.
PortalSiteConnectionObjectA page of sites.
PortalSiteDocumentObjectA site version's source read as typed parts. Part order is the document's.
PortalSiteIDScalarTyped identifier of a PortalSite, serialized as a `pos_` TypeID string.
PortalSitePayloadObjectResult of a site mutation.
PortalSiteVersionObjectAn immutable source snapshot of a site. Publishing one makes it the served version; publishing an older one rolls back.
PortalSiteVersionConnectionObjectA page of site versions.
PortalSiteVersionIDScalarTyped identifier of an immutable PortalSiteVersion snapshot, serialized as a `psv_` TypeID string.
PortalSiteVersionPayloadObjectResult of a site version mutation.
PortalUserObjectA person who signs in to Portals. PortalUsers are tenant-wide and distinct from internal Users.
PortalUserConnectionObjectA page of PortalUsers.
PortalUserIDScalarTyped identifier of a PortalUser, serialized as a `pou_` TypeID string.
PortalUserPayloadObjectResult of a PortalUser mutation.
QueryScalarScalarA URI-style string defining an entity, optional ID, and filter parameters. Format: <noun>[#<id>][?<key>=<value>,...]. Examples: 'jobs?limit=100,status=approved', 'job#01H...'.
ReservePortalDomainInputInputA custom domain alias to reserve for a Portal.
StringScalarThe `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.
UpdateJourneyInputInputPatch 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.
UpdateJourneySourceInputInputRevision-checked edit of journey XML, scope or team assignments using native validation and authorization.
UpdatePortalInputInputPatch for a Portal. Omitted fields keep their current values.
UpdatePortalMembershipInputInputPatch for a membership. Omitted fields keep their current values.
UpdatePortalSiteInputInputPatch for a site. Omitted fields keep their current values.
UpdatePortalUserInputInputPatch for a PortalUser. Omitted fields keep their current values.
UpdateWorkspaceInputInputInput for updating a workspace. Only provided fields are changed.
UpsertJourneyInputInputAuthoring input for `upsertJourney`: create a journey, or overwrite the open draft of the journey whose handle matches the definition's `id`.
UpsertWorkspaceInputInputInput for `upsertWorkspace`: create a workspace or overwrite its open draft, keyed on the workspace id inside sourceXML.
ValidateSurfacePayloadObjectResult of a standalone surface-definition validation (journey or workspace), without persisting.
WorkspaceObjectAn 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.
WorkspaceAuthoringAnalysisObjectExecution-free analysis of Workspace XML and server Lua for authoring tools.
WorkspaceConnectionObjectA paginated, cursor-based page of workspaces returned by `listWorkspaces`.
WorkspaceFilterInputInputFilter for `listWorkspaces`. All supplied criteria must match (AND).
WorkspaceIDScalarUnique identifier for a workspace
WorkspacePayloadObjectResult of a workspace mutation: the workspace on success, or field-level validation errors.
WorkspaceSortInputInputOne ordering term for `listWorkspaces`. Only the first term is applied; the default is UPDATED_AT / DESC.
WorkspaceVersionObjectOne immutable version of a workspace's definition. Versions form the authoring history; `listWorkspaceVersions` returns them newest first.
WorkspaceVersionConnectionObjectA page of a workspace's authoring history returned by `listWorkspaceVersions`.