Scopes
Permissions for API tokens and MCP, and the tools and endpoints each one allows.
API tokens and OAuth grants use scopes to decide what a client can call. When you choose permissions, each one is shown by name, such as Docs — Read or User — Read. The table maps that name to the OAuth scope, the MCP tools it unlocks, and the API reference pages it authorizes.
A few permissions overlap:
- The folder read endpoints accept either
folder:readorproject:read, so they appear under both Folder — Read and Project — Read. - File — Write is one permission covering
data:file_importanddoc:file_import. The upload endpoints listed below accept either scope. Importing into data requiresdata:file_import. Importing into a doc requiresdoc:file_import. - The table omits legacy
/v1/notesroutes. Those usenote:read,note:write, andnote:delete, andPOST /v1/notes/import/filerequiresdata:file_import. - The table omits deprecated
/v1/insightsroutes. Those use the Docs scopes, the comment scopes on/v1/insights/:insight_id/comments, anddoc:file_importforPOST /v1/insights/import/file. DeprecatedPOST /v1/files/requiresdoc:file_importonly.
| Name | OAuth Scope | MCP Tools | API Endpoints |
|---|---|---|---|
| Channel — Read | channel:read | list_channelsget_channellist_channel_dataget_channel_datumlist_channel_themes | List channels Get channel List channel data points Get data point List channel themes |
| Channel — Write | channel:write | create_channel_datum | Create channel Patch channel Create topic Patch topic Create data point Create data point on a dataset |
| Channel — Delete | channel:delete | None | Delete channel Delete topic |
| Chat — Read | chat:read | None | Not available |
| Chat — Write | chat:write | None | Not available |
| Comments — Read | comment:read | list_doc_commentsget_doc_comment | List doc comments Get doc comment |
| Comments — Write | comment:write | create_comment | Resolve comment thread Unresolve comment thread Create doc comment Update doc comment |
| Comments — Delete | comment:delete | None | Delete doc comment |
| Contact — Read | contact:read | get_contactlist_contacts | Get contact List contacts |
| Contact — Write | contact:write | None | Create contact Update contact |
| Contact — Delete | contact:delete | None | Delete contact |
| Data — Read | note:read | list_project_dataget_project_dataget_data_contentget_project_highlightsget_highlightlist_tagslist_tag_boardsget_tag | List data Get data Export data List highlights Get highlight List tags List tag boards Get tag |
| Data — Write | note:write | create_datacreate_transcript_highlightapply_tagscreate_tag | Magic Summarize Create data Patch data Create transcript highlight Apply tags to highlight Create tag Add utterance Set transcript from download URL Attach audio |
| Data — Delete | note:delete | None | Delete data |
| Docs — Read | insight:read | list_docslist_personal_docsget_docget_doc_contentget_workspace_context | List docs List personal docs Get doc Export doc Get workspace context |
| Docs — Write | insight:write | create_docadd_workspace_context_doc | Patch doc Create doc Add workspace context doc |
| Docs — Delete | insight:delete | None | Delete doc |
| Field — Read | field:read | list_fieldsget_field | List fields Get field |
| Field — Write | field:write | None | Create field Update field |
| Field — Delete | field:delete | None | Delete field |
| File — Read | file:read | get_filedownload_file | Get file by id Download a file |
| File — Write | data:file_importdoc:file_import | import_file_to_dataimport_file_to_docupload_filecomplete_file_upload | Import file to data Import file to doc Initiate a single-PUT file upload Initiate a large (multipart) file upload Finalize a single-PUT file upload Finalize a large (multipart) file upload |
| Folder — Read | folder:read | list_foldersget_folderget_folder_contents | List folders Get folder Get folder contents |
| Folder — Write | folder:write | create_folder | Create folder Patch folder |
| Folder — Delete | folder:delete | None | Delete folder |
| Project — Read | project:read | list_foldersget_folderget_folder_contentslist_project_templatesget_dovetail_projectsget_projectget_project_context | List folders Get folder Get folder contents List project templates List projects Get project Get project context |
| Project — Write | project:write | create_projectadd_project_context_keywordsadd_project_context_doclink_workspace_field_group | Create project Patch project Add project context keywords Remove project context keywords Add project context doc Remove project context doc Link workspace field group |
| Project — Delete | project:delete | None | Delete project |
| Search — Read | search:read | search_workspace | Magic Search Search V2 |
| User — Read | user:read | get_userlist_users | Get user List users |
Updated 3 days ago
Did this page help you?