# Matterport

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

- **Category:** developer tools
- **Auth:** BASIC, OAUTH2
- **Composio Managed App Available?** No
- **Tools:** 6
- **Triggers:** 0
- **Slug:** `MATTERPORT`
- **Version:** 00000000_00

## Tools

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the Matterport model to be permanently deleted |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Model by ID

**Slug:** `MATTERPORT_MODEL`

Tool to retrieve detailed information about a single Matterport 3D model by its ID. Use when you need to fetch model metadata, publication details, spatial information, or other properties of a specific Matterport model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `modelId` | string | Yes | Unique identifier of the Matterport model to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Model Event Webhook Callbacks

**Slug:** `MATTERPORT_MODEL_EVENT_WEBHOOK_CALLBACKS`

Tool to retrieve a list of registered webhook callback configurations for model events. Use when you need to view all configured webhooks that receive notifications when model events occur (e.g., created, deleted, updated, processed, transferred).

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | 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 | No | Offset ID for pagination. Use the 'nextOffset' value from a previous response to retrieve the next page of results |
| `sortBy` | array | No | Determines result ordering. Valid values: 'created' (creation timestamp), 'modified' (modification timestamp), 'name' (alphabetical). Defaults to creation timestamp descending if not specified |
| `include` | array | No | Include additional models in non-active states. Valid values: 'demo' (include demo models), 'inactive' (include archived models) |
| `pageSize` | integer | No | Maximum number of results per page. Maximum allowed is 1000, default is 10 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Room Classifications

**Slug:** `MATTERPORT_ROOM_CLASSIFICATIONS`

Tool to list all room classifications defined for Matterport room classification models. Use when you need to retrieve the available room types and their associated keywords.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Model State

**Slug:** `MATTERPORT_UPDATE_MODEL_STATE`

Tool to change a Matterport model between active and inactive (archived) states. Use when you need to archive an inactive model or unarchive an active model. This operation is idempotent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The model identifier to modify |
| `field` | string ("id" | "internalId" | "mlsId") | No | 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") | Yes | Target state for the model. Use 'active' to unarchive the model or 'inactive' to archive the model |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |