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
Int
open_in_new
Built-in Int
GraphQL Schema definition
scalar
Int
Require by
Clip
A video clip
ExternalAttachmentDetails
undefined
Floorplan
A floorplan, often formatted as an image, although other options may be available.
Folder
undefined
Image
undefined
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.
ModelBillingInformation
The model specific information necessary for billing.
ModelEventWebhookCallbackList
A page of model event webhook callbacks. In order to access the next page, call `modelEventWebhookCallbacks` again with all parameters the same except passing in `nextOffset` for `offset`.
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.
ModelSearchFloors
Search summary information about all the floors in the model.
ModelSearchLocations
Search summary information about all the anchor locations within a model.
ModelSearchMattertags
Search summary information about all the mattertags in the model.
ModelSearchMeasurements
Search summary information about all the measurements in the model.
ModelSearchMeshes
Search summary information about all the 3D meshes associated with the model.
ModelSearchPanoLocations
Search summary information about all the anchor locations within a model.
ModelSearchPanos
Search summary information about all the panoramic images in the model.
ModelSearchResultList
A page of models matching the specified query. In order to access the next page, call `models` again with all parameters the same except passing in `nextOffset` for `offset`.
ModelSearchRooms
Search summary information about all the rooms in the model.
ModelSearchTextures
Search summary information about all the textures associated with the model.
ModelViewLayer
Information about a layer's position and display within a given view.
Note
A point in the model for users to comment and attach other media.
PagedFolderList
undefined
PagedModelList
undefined
Photo
A photo associated with the model as well as some basic metadata including label and dimensions.
Query
Data fetch operations.
ScanEstimates
undefined
Texture
An image which may be mapped onto a 3D geometry.
WebhookCallback
This data is the limited set of publicly accessible information for a callback.
WebhookCallbackInput
Specifies the callback details for the input
WebhookCallbackPatchInput
Specifies the callback details for the patch input