GraphQL Schema
Schema
Query
Mutation
Scalars
BigDecimal
BigInteger
Boolean
Byte
ByteString
Char
DateTime
Duration
Float
ID
Int
JSON
Long
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
ModelAccessVisibility
ModelActivationState
ModelBackgroundColor
ModelBranding
ModelEventType
ModelFlag
ModelIdField
ModelPlayerView
ModelProcessingState
ModelSortField
ModelState
ModelStateChange
ModelType
ModelVisibility
OpeningType
PanoramaPlacement
PanoramaSource
PanoramicImageFormat
ParentType
PhotoResolution
PhotoType
ProcessingState
ResolutionStatus
RoomDataType
SearchInclusion
SettingOverride
SharedResource
SharedSource
SortOrder
TextureQuality
Units
WebhookCredType
__DirectiveLocation
__TypeKind
Interfaces
Annotation
Asset
AssetBundle
CommonAsset
Image
LayeredElement
Lockable
ModelSummary
OrganizationSummary
PanoramicImage
Shareable
UserSummary
Unions
ObjectAnnotationSource
ReelElementAsset
Region
SharedWithDetails
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
ModelLayer
ModelMlsDetails
ModelOptions
ModelProcessingDetails
ModelPublicationDetails
ModelRoom
ModelSearchAssets
ModelSearchFloors
ModelSearchLocations
ModelSearchMattertags
ModelSearchMeasurements
ModelSearchMeshes
ModelSearchPanoLocations
ModelSearchPanos
ModelSearchPublicationDetails
ModelSearchResult
ModelSearchResultList
ModelSearchRooms
ModelSearchTextures
ModelShareAccessLevel
ModelView
ModelViewLayer
Note
ObjectAccess
ObjectAccessResultsList
ObjectAnnotation
ObjectClassification
Opening
OrganizationMetadata
PagedFolderList
PagedModelList
PanoramicImageLocation
PanoramicImageOption
PermissionSet
Photo
PhotoSummary
Point
Point2D
Pose
PrivateModelLink
Quaternion
ReelElement
Resource
RoleSummary
RoomClassification
ScanEstimates
ShareableFolderSummary
ShareableModelSummary
ShareableObject
SharedWith
SkyboxPanorama
SnapshotLocation
Texture
UserAccess
UserAccessResultsList
UserFolderShareAccess
UserGroupSummary
UserMetadata
UserModelShareAccess
VectorRegion
Vertex
WebhookCallback
__Directive
__EnumValue
__Field
__InputValue
__Schema
__Type
Input Objects
BackgroundColorSettingOverride
BoundedRegionDetails
CommentDetails
CommentPatch
CommentSort
CopyInput
DimensionDataPatch
DimensionPatch
EdgeDetails
ExternalAttachmentDetails
FloorPatch
FolderAccessQuery
FolderDetails
FolderPatch
IMeasurementPathPoint
IPoint2D
IPoint3D
KeyValueInput
LabelDetails
LabelPatch
ManifestInput
MattertagDetails
MattertagPatch
MeasurementDetails
MeasurementPatch
MeasurementPathDetails
MeasurementPathPatch
MeasurementsModeOverride
MlsDetailsPatch
ModelAssetsPatch
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
Float
open_in_new
Built-in Float
GraphQL Schema definition
scalar
Float
Require by
Dimension
Estimate of room or floor dimensions. This information is not fully available on all models. @deprecated 05/17/2023
DimensionPatch
@beta This is part of the Property Insights Beta Used to patch the dimensionEstimates field on rooms.
Dimensions
@beta This is part of the Property Insights Beta Dimension estimates for rooms/floors/models part of Matterport Property Insights.
Edge
@beta This is part of the Property Insights Beta Defines an edge of a bounded region. Edges correspond to walls or borders of rooms, represented as a collection of metadata and vertices on a 2D plane within the model.
EdgeDetails
@beta This is part of the Property Insights Beta Used to create and patch bounded region edges.
Floorplan
A floorplan, often formatted as an image, although other options may be available.
IPoint2D
A 2D point used as an input.
IPoint3D
A 3D point used as an input.
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.
MeasurementPath
A representation of measurement path made up of a sequence of points within the model. This structure is intended to replace measurements.
Model
A digital twin, metadata and access to assets associated with a 3D model of a space.
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.
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.
Opening
@beta This is part of the Property Insights Beta Defines an opening on a bounded region edge.
OpeningDetails
@beta This is part of the Property Insights Beta Used to create and patch bounded region edge openings.
Point
A 3D point in space. Generally used to mark a location or position within the model.
Point2D
A 2D point in space. Generally used to mark a location or position within a 2D plane of the model.
Quaternion
A 4D vector. Generally used in conjunction with a point to describe a camera for rendering a 3D image within the model.
RoomClassification
@beta This is part of the Property Insights Beta
VectorRegion
undefined