> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Matterport

> Capture, share, and collaborate the built world in immersive 3D

![Matterport logo](https://mintcdn.com/composio-preview/ufpARLIsio16odJB/images/toolkits/matterport.svg?fit=max\&auto=format\&n=ufpARLIsio16odJB\&q=85\&s=8bfd052e37cfaef0f3d04d6370303cfa)

* **Category:** developer tools
* **Auth:** BASIC, OAUTH2
* **Composio-managed OAuth available?** No
* **Tools:** 6
* **Triggers:** 0
* **Slug:** `MATTERPORT`
* **Version:** 20261101\_00

## Tools

> [accordion] Delete Matterport Model
>
> **Slug:** `MATTERPORT_DELETE_MODEL`
>
> Tool 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
>
> **id** `string` *required*
>
> Unique identifier of the Matterport model to be permanently deleted
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Model by ID
>
> **Slug:** `MATTERPORT_MODEL`
>
> Retrieve 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
>
> **modelId** `string` *required*
>
> Unique identifier of the Matterport model to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Model Event Webhook Callbacks
>
> **Slug:** `MATTERPORT_MODEL_EVENT_WEBHOOK_CALLBACKS`
>
> Retrieve 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query Matterport Models
>
> **Slug:** `MATTERPORT_MODELS`
>
> Tool 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
>
> **query** `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
>
> **offset** `string`
>
> Offset ID for pagination. Use the 'nextOffset' value from a previous response to retrieve the next page of results
>
> **sortBy** `array`
>
> Determines result ordering. Valid values: 'created' (creation timestamp), 'modified' (modification timestamp), 'name' (alphabetical). Defaults to creation timestamp descending if not specified
>
> **include** `array`
>
> Include additional models in non-active states. Valid values: 'demo' (include demo models), 'inactive' (include archived models)
>
> **pageSize** `integer`
>
> Maximum number of results per page. Maximum allowed is 1000, default is 10
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Room Classifications
>
> **Slug:** `MATTERPORT_ROOM_CLASSIFICATIONS`
>
> List Matterport room classifications, including room types and associated keywords. This query is available to organizations enrolled in the Property Insights graph extension.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Model State
>
> **Slug:** `MATTERPORT_UPDATE_MODEL_STATE`
>
> Change a Matterport model between active and inactive (archived) states. Use it to archive an active model or unarchive an inactive model.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The model identifier to modify
>
> **field** `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
>
> **state** `string ("active" | "inactive")` *required*
>
> Target state for the model. Use 'active' to unarchive the model or 'inactive' to archive the model
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
