Skip to main content
Matterport logo
  • Category: developer tools
  • Auth: BASIC, OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 6
  • Triggers: 0
  • Slug: MATTERPORT
  • Version: 20261101_00

Tools

Slug: MATTERPORT_DELETE_MODELTool to permanently delete a Matterport model. Use when you need to remove a model entirely from the Matterport platform. This operation is irreversible.

Input Parameters

string
required
Unique identifier of the Matterport model to be permanently deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MATTERPORT_MODELRetrieve detailed information about a Matterport 3D model by ID, including metadata, publication details and spatial information. A not-found error returns an empty model response.

Input Parameters

string
required
Unique identifier of the Matterport model to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MATTERPORT_MODEL_EVENT_WEBHOOK_CALLBACKSRetrieve the first page of registered model event webhook callback configurations for the organization. When the organization’s webhook policy is disabled, the tool may return an empty result.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MATTERPORT_MODELSTool to retrieve a page of Matterport models with optional search and filtering. Use when you need to list, search, or filter models within an organization.

Input Parameters

string
Free text search string for models. Use ’*’ for all models, or provide specific search terms. If unspecified, all models within the organization are returned
string
Offset ID for pagination. Use the ‘nextOffset’ value from a previous response to retrieve the next page of results
array
Determines result ordering. Valid values: ‘created’ (creation timestamp), ‘modified’ (modification timestamp), ‘name’ (alphabetical). Defaults to creation timestamp descending if not specified
array
Include additional models in non-active states. Valid values: ‘demo’ (include demo models), ‘inactive’ (include archived models)
integer
Maximum number of results per page. Maximum allowed is 1000, default is 10

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MATTERPORT_ROOM_CLASSIFICATIONSList Matterport room classifications, including room types and associated keywords. This query is available to organizations enrolled in the Property Insights graph extension.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MATTERPORT_UPDATE_MODEL_STATEChange a Matterport model between active and inactive (archived) states. Use it to archive an active model or unarchive an inactive model.

Input Parameters

string
required
The model identifier to modify
string ("id" | "internalId" | "mlsId")
Specifies which ID field to use for lookup. Valid values: ‘id’ (primary identifier), ‘internalId’ (internal system identifier), ‘mlsId’ (MLS identifier). Defaults to primary identifier if not specified
string ("active" | "inactive")
required
Target state for the model. Use ‘active’ to unarchive the model or ‘inactive’ to archive the model

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not