Account API Overview

note

Account API is only available for Enterprise-level Matterport Subscriptions.

Introduction

The Account API is available only with Enterprise subscription tiers. It offers a variety of capabilities including, but not limited to:

• Query and search for organization, user, and role information for the account. See Custom Roles.
• Invite, remove, and edit users
• Assign, create, update, and delete folders
• Query and take actions on models within a folder, including getting the model count within a folder and moving a folder or model to a different folder

Access Requirements

The Account API is available exclusively to Matterport Enterprise plans. You must have:

• An active Matterport Enterprise account
• Developer Tools License
• API credentials (Token ID and Token Secret) generated through your Matterport Cloud account

For more information about Matterport Enterprise Subscription and Developer Tools, reach out to your Sales Executive.

GraphQL Endpoint

https://api.matterport.com/api/accounts/graph

You can also explore the schema interactively in the Account API GraphiQL console.

Getting Started

• Browse common request patterns on the Account API Samples page
• Learn about configuring custom user roles on the Custom Roles page

Schema Reference

For a complete reference of all available mutations and queries, see the API Schema Reference.