GraphQL Schema
Schema
Query
Mutation
Scalars
BigDecimal
BigInteger
Boolean
Byte
ByteString
Char
DateTime
Duration
Float
ID
Int
JSON
Short
String
Timestamp
TimeUUID
Unit
Enums
AccessInfoOrder
AddressStatus
AddressVisibility
AssetStatus
AttachmentMediaType
Availability
BundleProcessingStatus
CollisionResolution
CommentSortField
DeliverySpeed
EdgeType
FeatureAvailability
FloorplanFlag
FolderAccessFilter
GeoPointStatus
MatterportApplication
MattertagMediaType
MeasurementsMode
ModelAccessFilter
ModelBackgroundColor
ModelBranding
ModelEventType
ModelFlag
ModelIdField
ModelPlayerView
ModelSortField
ModelState
ModelStateChange
ModelVisibility
OpeningType
PanoramaPlacement
PanoramaSource
PanoramicImageFormat
ParentType
PhotoResolution
PhotoType
ProcessingState
ResolutionStatus
RoomDataType
SearchInclusion
SettingOverride
SharedResource
SortOrder
TextureQuality
Units
WebhookCredType
__DirectiveLocation
__TypeKind
Interfaces
Annotation
Asset
AssetBundle
CommonAsset
Image
Lockable
ModelSummary
OrganizationSummary
PanoramicImage
UserSummary
Unions
ObjectAnnotationSource
ReelElementAsset
Region
Objects
AccessInfo
AccessInfoList
Address
AnchorLocation
BoundedRegion
BundleOptions
BundleProcessingInformation
Clip
Comment
CommentResultList
Dimension
DimensionData
Dimensions
Edge
Floorplan
Folder
FolderShareAccessLevel
GeoLocation
GeoPoint
HighlightReel
InferenceEvent
KeyValue
Label
Mattertag
Measurement
MeasurementPath
MeasurementPathPoint
Mesh
Model
ModelAssets
ModelBillingInformation
ModelBundle
ModelContact
ModelEventWebhookCallback
ModelEventWebhookCallbackList
ModelFloor
ModelMlsDetails
ModelOptions
ModelProcessingDetails
ModelPublicationDetails
ModelRoom
ModelSearchAssets
ModelSearchFloors
ModelSearchLocations
ModelSearchMattertags
ModelSearchMeasurements
ModelSearchMeshes
ModelSearchPanoLocations
ModelSearchPanos
ModelSearchPublicationDetails
ModelSearchResult
ModelSearchResultList
ModelSearchRooms
ModelSearchTextures
ModelShareAccessLevel
ModelView
Note
ObjectAnnotation
ObjectClassification
Opening
OrganizationMetadata
PagedFolderList
PagedModelList
PanoramicImageLocation
PanoramicImageOption
PermissionSet
Photo
PhotoSummary
Point
Point2D
Pose
PrivateModelLink
Quaternion
ReelElement
Resource
SkyboxPanorama
SnapshotLocation
Texture
UserFolderShareAccess
UserMetadata
UserModelShareAccess
VectorRegion
Vertex
WebhookCallback
__Directive
__EnumValue
__Field
__InputValue
__Schema
__Type
Input Objects
BackgroundColorSettingOverride
BoundedRegionDetails
CommentDetails
CommentPatch
CommentSort
CopyInput
DimensionDataPatch
DimensionPatch
EdgeDetails
ExternalAttachmentDetails
FloorPatch
FolderDetails
FolderPatch
IMeasurementPathPoint
IPoint2D
IPoint3D
KeyValueInput
LabelDetails
LabelPatch
MattertagDetails
MattertagPatch
MeasurementDetails
MeasurementPatch
MeasurementPathDetails
MeasurementPathPatch
MeasurementsModeOverride
MlsDetailsPatch
ModelContactPatch
ModelEventCallbackInput
ModelEventCallbackPatchInput
ModelOptionsPatch
ModelPatch
ModelSort
NoteDetails
NotePatch
OpeningDetails
PublicationDetailsPatch
ReelElementInput
RoomAssociations
RoomDataSelection
RoomDetails
UnitSettingOverride
UnlockOptions
VertexDetails
WebhookCallbackInput
WebhookCallbackPatchInput
Directives
date
deprecated
include
onError
skip
specifiedBy
Boolean
open_in_new
Built-in Boolean
GraphQL Schema definition
scalar
Boolean
Require by
Annotation
Common interface for annotations or virtual overlays added to the model.
BackgroundColorSettingOverride
Override the presentation background settings.
Comment
Markdown text and/or attachments made on an annotation.
CopyInput
Specification of the data to copy
Folder
undefined
Label
A label of a room in the model.
LabelDetails
undefined
LabelPatch
undefined
Mattertag
A point in the model with other information such as clips, photos and text associated with it.
MattertagDetails
undefined
MattertagPatch
undefined
Measurement
A measurement between two points within the model.
MeasurementDetails
undefined
MeasurementPatch
undefined
MeasurementPath
A representation of measurement path made up of a sequence of points within the model. This structure is intended to replace measurements.
MeasurementPathDetails
undefined
MeasurementPathPatch
undefined
MeasurementsModeOverride
Override the mode in which users can interact with measurements.
Model
A digital twin, metadata and access to assets associated with a 3D model of a space.
ModelBillingInformation
The model specific information necessary for billing.
ModelFloor
Represents a floor within the model. This is generally used as a navigation helper as well as a container for rooms, locations and annotations.
ModelOptions
Settings for what options are enabled on a given model. Most of these options are set at the account level but may be overridden for specific models.
ModelPublicationDetails
Information related to displaying public model information.
ModelRoom
A room within the model, this acts as a container for other information.
ModelSearchPublicationDetails
Search summary information related to the public model information.
ModelSearchResult
This is a flattened representation of the model which removes or merges all lists of complex objects so that the fields may be directly queried. Any field on this object may be included as a keyword in the models query. For example "name: Demo" would search for models with the word Demo in the name. A search for "mattertags.labels: kitchen" would search for any models that have at least one mattertag with the word kitchen in the label.
ModelSummary
A base interface of common fields found on the model returned from a full get or from the search results.
ModelView
An alternative view of the same model.
Mutation
Data update operations.
Note
A point in the model for users to comment and attach other media.
NoteDetails
undefined
NotePatch
undefined
ObjectAnnotation
@beta This field is part of a limited access beta.
RoomAssociations
@beta This is part of the Property Insights Beta Used to update the associations of annotations/locations to their rooms.
RoomDataSelection
@beta This is part of the Property Insights Beta A selector establishing what room data to update.
UnitSettingOverride
Override the units player option setting.
__Directive
undefined
__EnumValue
undefined
__Field
undefined
__InputValue
undefined
__Type
undefined