# Dovetail Documentation > Documentation for Dovetail ## Guides: GET STARTED - [Comments](https://developers.dovetail.com/docs/comments-1.md): Manage comments on docs and insights. - [Introduction](https://developers.dovetail.com/docs/introduction.md): Learn how to build your own integrations with Dovetail. - [Authorization](https://developers.dovetail.com/docs/authorization.md): This guide describes the authorization flows for Dovetail’s Public API. - [Rate Limits](https://developers.dovetail.com/docs/rate-limits.md): This guide provides details about rate limiting in Dovetail to help you anticipate and manage rate limiting - [Pagination](https://developers.dovetail.com/docs/pagination.md): This guide describes how list resources are paginated. - [Filters](https://developers.dovetail.com/docs/filters.md): This guide describes how list resources can be filtered. - [Sort](https://developers.dovetail.com/docs/sort.md): This guide describes how list resources can be sorted. - [OAuth 2.0](https://developers.dovetail.com/docs/oauth-2.md): Learn how to authenticate users through third party applications. - [Content Formats](https://developers.dovetail.com/docs/content-formats.md): Learn how to create docs with Markdown, HTML, or plain text content. - [Comments](https://developers.dovetail.com/docs/comments.md): Manage comments on docs and insights. ## Guides: Agent APIs - [Dovetail MCP server](https://developers.dovetail.com/docs/mcp.md): Connect AI agents to your Dovetail workspace. - [Self-hosted MCP server](https://developers.dovetail.com/docs/mcp-self-hosted.md): Run the Dovetail MCP server locally for STDIO-based clients. ## API Reference: Dovetail Public API - Authentication - [Token info](https://developers.dovetail.com/reference/get_v1-token-info.md): Retrieve information about the API token used to authenticate this request. Use this endpoint to verify that your token is valid and to determine which workspace it belongs to. Returns the token's… - Search - [Magic Search](https://developers.dovetail.com/reference/post_v1-search.md): Perform a full-text search across your workspace's content. Returns matching highlights, data (notes), insights, channels, tags, and themes in a single response. Use the `query` field for keyword… - [Search V2](https://developers.dovetail.com/reference/post_v2-search.md): Perform an advanced search across your entire Dovetail workspace. This is the recommended search endpoint, supporting all content types: agents, highlights, data (notes), insights, channels,… - Summarize - [Magic Summarize](https://developers.dovetail.com/reference/post_v1-summarize.md): Generate an AI-powered summary from a collection of highlights, data entries (notes), insights, themes, and/or tags. Provide one or more arrays of IDs and Dovetail will synthesize the content into a… - Channels - [Create channel](https://developers.dovetail.com/reference/post_v1-channels.md): Create a new channel in your workspace. A channel is an automated pipeline for analyzing customer feedback at scale. You must specify a `content_type` (e.g. `APP_REVIEW`, `NPS_FEEDBACK`,… - [Patch channel](https://developers.dovetail.com/reference/patch_v1-channels-channel-id.md): Update a channel's properties. Supports updating the title and the context (a description of the channel's main goal or purpose, which helps Dovetail's AI better classify incoming data). Only the… - [Delete channel](https://developers.dovetail.com/reference/delete_v1-channels-channel-id.md): Delete a channel. Deleted channel end up in your specific project's trash, but can be restored for up to 30 days before they’re automatically and permanently deleted. Returns the deleted channel… - [Create topic](https://developers.dovetail.com/reference/post_v1-channels-topic.md): Create a new topic within a channel. Topics are categories used by Dovetail's AI to classify incoming data points. Each topic has a title and description that guide how data is sorted. You must… - [Patch topic](https://developers.dovetail.com/reference/patch_v1-channels-topic-topic-id.md): Update a topic's title and/or description. Only the fields you include in the request body will be modified — omitted fields are left unchanged. Updating a topic's description can change how future… - [Delete topic](https://developers.dovetail.com/reference/delete_v1-channels-topic-topic-id.md): Delete a topic. Deleted topic end up in your specific project's trash, but can be restored for up to 30 days before they’re automatically and permanently deleted. Returns the deleted topic object.… - [Create data point](https://developers.dovetail.com/reference/post_v1-channels-data.md): Send a new data point to a channel for automated AI analysis. Each data point represents a single piece of customer feedback (e.g. an app review, a support ticket, or an NPS response). The `text`… - [List channels](https://developers.dovetail.com/reference/get_v1-channels.md): Retrieve all channels in your workspace. Channels are automated analysis pipelines that continuously process high-volume unstructured customer feedback (e.g. app reviews, NPS responses, support… - [Get channel](https://developers.dovetail.com/reference/get_v1-channels-channel-id.md): Retrieve a single channel's metadata by its unique identifier. Returns title, creation date, folder location, and a list of its topics (AI-generated categories used to classify incoming data points).… - [List channel themes](https://developers.dovetail.com/reference/get_v1-channels-channel-id-themes.md): Retrieve all themes for a channel. Themes are AI-generated clusters of data points that share a common subject within a topic. Each theme has a `title` (a short label summarising the cluster), an… - [List channel data points](https://developers.dovetail.com/reference/get_v1-channels-channel-id-data.md): Get a list of data points for a channel. > 🚧 Permissions > > Please check you have the relevant permissions required to access this resource. This may include specific permissions on the object… - [Get data point](https://developers.dovetail.com/reference/get_v1-channels-data-datum-id.md): Get a data point by id. > 🚧 Permissions > > Please check you have the relevant permissions required to access this resource. This may include specific permissions on the object itself or its parent,… - Folders - [List folders](https://developers.dovetail.com/reference/get_v1-folders.md): Retrieve all folders in your workspace. Folders are used to organize projects, docs, channels, dashboards, agents, and other folders into a hierarchical structure — similar to a file system. Results… - [Get folder](https://developers.dovetail.com/reference/get_v1-folders-folder-id.md): Retrieve a single folder by its unique identifier. Returns the folder's metadata including title, parent folder, creation date, and a list of immediate child folder IDs. Use this endpoint to inspect… - [Get folder contents](https://developers.dovetail.com/reference/get_v1-folders-folder-id-contents.md): Retrieve all items contained within a specific folder. Returns a paginated list of projects, docs, channels, dashboards, agents, and child folders that are direct children of the specified folder.… - [Create folder](https://developers.dovetail.com/reference/post_v1-folders.md): Create a new folder in your Dovetail workspace. Folders organize projects, docs, channels, and other content into a hierarchical structure. Optionally provide a `parent_folder_id` to nest the folder… - [Patch folder](https://developers.dovetail.com/reference/patch_v1-folders-folder-id.md): Update a folder's properties. Currently supports updating the folder title. Only the fields you include in the request body will be modified. Returns the updated folder object. > 🚧 Permissions > >… - [Delete folder](https://developers.dovetail.com/reference/delete_v1-folders-folder-id.md): Delete a folder. Deleted folders end up in your workspace's trash, but can be restored for up to 30 days before they're automatically and permanently deleted. Returns the deleted folder object. >… - Projects - [List projects](https://developers.dovetail.com/reference/get_v1-projects.md): Retrieve all projects in your workspace. Projects are containers for organizing qualitative research — they hold data, docs, highlights, tags, and insights related to a specific research initiative.… - [Create project](https://developers.dovetail.com/reference/post_v1-projects.md): Create a new project in your Dovetail workspace. Projects are the primary container for organizing research — they hold data, docs, highlights, tags, and insights. Optionally provide a `template_id`… - [Get project](https://developers.dovetail.com/reference/get_v1-projects-project-id.md): Retrieve a single project by its unique identifier. Returns the project's metadata including title, author, creation date, folder location, and overview content in Markdown format. Use this endpoint… - [Patch project](https://developers.dovetail.com/reference/patch_v1-projects-project-id.md): Update a project's properties. Currently supports updating the project title. Only the fields you include in the request body will be modified. Returns the updated project object. > 🚧 Permissions >… - [Delete project](https://developers.dovetail.com/reference/delete_v1-projects-project-id.md): Delete a project. Deleted projects end up in your workspace's trash, but can be restored for up to 30 days before they're automatically and permanently deleted. Returns the deleted project object.… - [List project templates](https://developers.dovetail.com/reference/get_v1-projects-templates.md): Retrieve all project templates available in your workspace. Templates are reusable blueprints that define a project's fields, views, tags, and structural layout. Use the returned template IDs with… - [Get project context](https://developers.dovetail.com/reference/get_v1-projects-project-id-context.md): Retrieve the AI context for a project, including its keywords and linked insight docs. Keywords guide AI features such as highlighting and tagging suggestions. Docs are insights used as source… - [Add project context keywords](https://developers.dovetail.com/reference/post_v1-projects-project-id-context-keywords.md): Add one or more keywords to the project's AI context. Duplicate keywords are ignored. Returns the full updated list of keywords. > 🚧 Permissions > > Please check you have the relevant permissions… - [Remove project context keywords](https://developers.dovetail.com/reference/delete_v1-projects-project-id-context-keywords.md): Remove one or more keywords from the project's AI context. Keywords not present in the current list are ignored. Returns the full updated list of keywords. > 🚧 Permissions > > Please check you have… - [Add project context doc](https://developers.dovetail.com/reference/post_v1-projects-project-id-context-docs.md): Add an insight to the project's AI context. A project can have at most 10 context docs. If the insight is already linked, this is a no-op. Returns the full updated list of context docs. > 🚧… - [Remove project context doc](https://developers.dovetail.com/reference/delete_v1-projects-project-id-context-docs-doc-id.md): Remove an insight from the project's AI context. If the insight is not linked, this is a no-op. Returns the full updated list of context docs. > 🚧 Permissions > > Please check you have the relevant… - [Link workspace field group](https://developers.dovetail.com/reference/post_v1-projects-project-id-workspace-field-groups.md): Link a workspace field group to a project so the group's fields are available on that project's data and docs. For callers with write permission, linking the same group twice is a no-op. Returns… - Data - [List data](https://developers.dovetail.com/reference/get_v1-data.md): Retrieve all data entries in your workspace. Data entries are documents within a project that capture raw research data such as interview transcripts, survey responses, support tickets, and session… - [Create data](https://developers.dovetail.com/reference/post_v1-data.md): Create a new data entry within a Dovetail project. Data entries capture raw research data — interview transcripts, survey responses, support tickets, or CRM records. They must be associated with a… - [Get data](https://developers.dovetail.com/reference/get_v1-data-data-id.md): Retrieve a single data entry by its unique identifier. The response is **metadata only** with respect to the entry body: it includes title, custom fields, associated project, folder, attached files,… - [Patch data](https://developers.dovetail.com/reference/patch_v1-data-data-id.md): Update a data entry's properties. Supports updating the title and custom fields. Only the fields you include in the request body will be modified — omitted fields are left unchanged. Returns the… - [Delete data](https://developers.dovetail.com/reference/delete_v1-data-data-id.md): Delete a data. Deleted data end up in your specific project's trash, but can be restored for up to 30 days before they’re automatically and permanently deleted. Returns the updated data object. >… - [Export data](https://developers.dovetail.com/reference/get_v1-data-data-id-export-type.md): Export the content body of a data entry in either HTML or Markdown format. Use the `type` path parameter to specify the desired format: `html` or `markdown`. This is the only GET endpoint that… - [Import file to data](https://developers.dovetail.com/reference/post_v1-data-import-file.md): Create a new data entry from a file. Provide the file in **exactly one** of two ways: - `url` — a publicly accessible URL that Dovetail downloads and imports, or - `file_id` — the id of a file you… - Datasets - [Create data point on a dataset](https://developers.dovetail.com/reference/post_v1-dataset-dataset-id-data.md): Send a new data point to a dataset, without it having to belong to a channel. A dataset is one connection under a source — the same thing shown as a dataset in the Dovetail UI. Sending data here… - Fields - [List fields](https://developers.dovetail.com/reference/get_v1-fields.md): Get a list of fields for a project or workspace field group. You must provide either `project_id` or `workspace_field_group_id` in the filter, along with `field_set_type` (`data` or `doc`). - [Create field](https://developers.dovetail.com/reference/post_v1-fields.md): Create a field in a project or workspace field group. You must provide either `project_id` or `workspace_field_group_id`, along with `field_set_type`. > 🚧 Permissions > > Please check you have the… - [Get field](https://developers.dovetail.com/reference/get_v1-fields-field-id.md): Get a field by id. > 🚧 Permissions > > Please check you have the relevant permissions required to access this resource. This may include specific permissions on the object itself or its parent, or… - [Update field](https://developers.dovetail.com/reference/patch_v1-fields-field-id.md): Update a field by id. > 🚧 Permissions > > Please check you have the relevant permissions required to access this resource. This may include specific permissions on the object itself or its parent,… - [Delete field](https://developers.dovetail.com/reference/delete_v1-fields-field-id.md): Delete a field by id. This is a soft delete. > 🚧 Permissions > > Please check you have the relevant permissions required to access this resource. This may include specific permissions on the object… - Files - [Get file by id](https://developers.dovetail.com/reference/get_v1-files-file-id.md): Retrieve metadata for a single file by its unique identifier. Returns the file's name, MIME type, size in bytes, processing status (`pending`, `completed`, or `failed`), author, and creation date.… - [Upload a file (deprecated)](https://developers.dovetail.com/reference/post_v1-files.md): **Deprecated** — use the v2 upload endpoints for new integrations: `POST /v2/files/upload` for files up to 5 GB and `POST /v2/files/large-upload` for files up to 10 GB. This endpoint is capped at 100… - [Initiate a single-PUT file upload](https://developers.dovetail.com/reference/post_v2-files-upload.md): Initiate a single-PUT upload for files **up to 5 GB**. The response includes a pre-signed `upload_url` that the client should `PUT` the full file body to. After the `PUT` succeeds, call **Complete… - [Finalize a single-PUT file upload](https://developers.dovetail.com/reference/post_v2-files-file-id-upload-complete.md): Finalize an upload session created by **Initiate single-PUT upload** (`POST /v2/files/upload`). The server `HEAD`s the S3 object to confirm bytes are present and that the size matches the declared… - [Initiate a large (multipart) file upload](https://developers.dovetail.com/reference/post_v2-files-large-upload.md): Initiate a multipart upload for files **up to 10 GB**. The response includes an opaque `upload_id` and a fully populated `urls` array containing one pre-signed `PUT` URL per part the client should… - [Finalize a large (multipart) file upload](https://developers.dovetail.com/reference/post_v2-files-file-id-large-upload-complete.md): Finalize an upload session created by **Initiate large upload** (`POST /v2/files/large-upload`). The `parts` array must include every part that was uploaded, with the `etag` returned by the storage… - [Download a file](https://developers.dovetail.com/reference/get_v1-files-file-id-download.md): Get a presigned URL to download the content of a file by its unique identifier. The response includes a short-lived URL that can be used to download the file directly from cloud storage without… - Highlights - [List highlights](https://developers.dovetail.com/reference/get_v1-highlights.md): Retrieve all highlights in your workspace. Highlights are selected passages of text (or time ranges in audio/video transcripts) within data entries that have been marked as significant during… - [Get highlight](https://developers.dovetail.com/reference/get_v1-highlights-highlight-id.md): Retrieve a single highlight by its unique identifier. Returns the highlight's text content, associated data entry, tags, and time range (for transcript highlights). > 🚧 Permissions > > Please check… - [Create transcript highlight](https://developers.dovetail.com/reference/post_v1-highlights.md): Create a highlight on a transcript by specifying start and end timestamps in seconds. The data entry (referenced by `note_id`) must contain an audio or video transcript for the highlight to be… - [Apply tags to highlight](https://developers.dovetail.com/reference/post_v1-highlights-highlight-id-tags.md): Apply one or more tags (up to 10 per request) to a highlight. Tags are labels used to categorize highlights during qualitative analysis (e.g. "Usability Issue", "Feature Request"). Each tag must… - Tags - [List tags](https://developers.dovetail.com/reference/get_v1-tags.md): Retrieve all tags in your workspace. Tags are labels used to categorize highlights during qualitative analysis (e.g. "Usability Issue", "Feature Request", "Positive Feedback"). Each tag is either a… - [Get tag](https://developers.dovetail.com/reference/get_v1-tags-tag-id.md): Retrieve a single tag by its unique identifier. Returns the tag's title, scope (`project` or `workspace`), the project it belongs to, its workspace tag board (for workspace tags), and its creation… - [Create tag](https://developers.dovetail.com/reference/post_v1-tags.md): Create a new tag. Tags are labels used to categorize highlights — for example "Usability Issue", "Feature Request", or "Positive Feedback". Pass `project_id` to create a project tag in that project.… - [List tag boards](https://developers.dovetail.com/reference/get_v1-tags-boards.md): Retrieve tag boards in your workspace. A tag board holds the tags (and tag groups) used to categorize highlights — every project has its own board, and a workspace can additionally have workspace tag… - Docs - [List docs](https://developers.dovetail.com/reference/get_v1-docs.md): Retrieve all docs in your workspace. Docs are rich-text documents used to write up research reports, share findings, and publish deliverables. They can exist within a project, inside a folder, or at… - [Create doc](https://developers.dovetail.com/reference/post_v1-docs.md): Create a new doc in your Dovetail workspace. Docs are rich-text documents used to write up research reports, share findings, and publish deliverables. You can provide the initial content as HTML,… - [List personal docs](https://developers.dovetail.com/reference/get_v1-docs-user-user-id.md): Retrieve all docs owned by a specific user. Returns docs that were created by or assigned to the specified user. **Note:** This endpoint is deprecated. Docs are no longer owned by individual users —… - [Get doc](https://developers.dovetail.com/reference/get_v1-docs-doc-id.md): Retrieve a single doc by its unique identifier. The response is **metadata only** with respect to the document body: it includes title, custom fields, project reference, folder, files, and cover… - [Delete doc](https://developers.dovetail.com/reference/delete_v1-docs-doc-id.md): Delete a doc. Deleted docs end up in your specific project's trash. They can be restored for up to 30 days before they're automatically and permanently deleted. Returns the updated doc object. > 🚧… - [Patch doc](https://developers.dovetail.com/reference/patch_v1-docs-doc-id.md): Update a doc's properties. Supports updating the title, custom fields, cover image, and folder location. Only the fields you include in the request body will be modified — omitted fields are left… - [Import file to doc](https://developers.dovetail.com/reference/post_v1-docs-import-file.md): Create a new doc by importing a file. Provide the file in **exactly one** of two ways: - `url` — a publicly accessible URL that Dovetail downloads and imports, or - `file_id` — the id of a file you… - [Export doc](https://developers.dovetail.com/reference/get_v1-docs-doc-id-export-type.md): Export the content body of a doc in either HTML or Markdown format. Use the `type` path parameter to specify the desired format: `html` or `markdown`. This is the only GET endpoint that returns the… - DocComments - [Resolve comment thread](https://developers.dovetail.com/reference/post_v1-docs-doc-id-comments-resolve.md): Resolve the comment thread on a doc. This marks the conversation as resolved. > 🚧 Permissions > > Please check you have the relevant permissions required to access this resource. This may include… - [Unresolve comment thread](https://developers.dovetail.com/reference/post_v1-docs-doc-id-comments-unresolve.md): Unresolve the comment thread on a doc. This reopens the conversation. > 🚧 Permissions > > Please check you have the relevant permissions required to access this resource. This may include specific… - [List doc comments](https://developers.dovetail.com/reference/get_v1-docs-doc-id-comments.md): Get a list of page-level and inline comments on a doc. Pass `?include_text_range=true` to include the selected text and surrounding context for inline comments. By default the list returns comment… - [Create doc comment](https://developers.dovetail.com/reference/post_v1-docs-doc-id-comments.md): Create a comment on a doc. If no comment thread exists on the doc, one will be created automatically. Pass optional `thread_id` to reply on an existing page-level or inline thread. The comment is… - [Get doc comment](https://developers.dovetail.com/reference/get_v1-docs-doc-id-comments-comment-id.md): Get a comment on a doc by id. > 🚧 Permissions > > Please check you have the relevant permissions required to access this resource. This may include specific permissions on the object itself or its… - [Update doc comment](https://developers.dovetail.com/reference/patch_v1-docs-doc-id-comments-comment-id.md): Update a comment on a doc. Only the comment author can update their own comments. > 🚧 Permissions > > Please check you have the relevant permissions required to access this resource. This may… - [Delete doc comment](https://developers.dovetail.com/reference/delete_v1-docs-doc-id-comments-comment-id.md): Delete a comment on a doc. Only the comment author can delete their own comments. Deleted comments can be restored for up to 30 days. Returns the deleted comment. > 🚧 Permissions > > Please check… - Insights - [List insights](https://developers.dovetail.com/reference/get_v1-insights.md): Retrieve all insights in your workspace. Insights are polished research deliverables — written reports that synthesize findings from data entries, highlights, and other sources into actionable… - [Create insight](https://developers.dovetail.com/reference/post_v1-insights.md): Create a new insight in your Dovetail workspace. Insights are polished research deliverables for sharing findings with stakeholders. **Note:** This endpoint is deprecated. Use **Create doc** (`POST… - [List personal insights](https://developers.dovetail.com/reference/get_v1-insights-user-user-id.md): Retrieve all insights owned by a specific user. Returns insights that were created by or assigned to the specified user. **Note:** This endpoint is deprecated. Insights are no longer owned by… - [Get insight](https://developers.dovetail.com/reference/get_v1-insights-insight-id.md): Retrieve a single insight by its unique identifier. Returns the insight's full metadata including title, custom fields, associated project, folder, files, and cover image. **Note:** This endpoint is… - [Delete insight](https://developers.dovetail.com/reference/delete_v1-insights-insight-id.md): Delete an insight. The insight is soft-deleted and moved to the project's trash. **Note:** This endpoint is deprecated. Use **Delete doc** (`DELETE /v1/docs/:doc_id`) instead. Deleted insights can… - [Patch insight](https://developers.dovetail.com/reference/patch_v1-insights-insight-id.md): Update an insight's properties. Supports updating the title, custom fields, cover image, and folder location. Only the fields you include in the request body will be modified — omitted fields are… - [Import file to insight](https://developers.dovetail.com/reference/post_v1-insights-import-file.md): Create a new insight by importing a file from a publicly accessible URL. Supported file types include documents (PDF, DOCX), audio files (MP3, WAV, M4A), and video files (MP4, MOV). **Note:** This… - [Export insight](https://developers.dovetail.com/reference/get_v1-insights-insight-id-export-type.md): Export the content body of an insight in either HTML or Markdown format. Use the `type` path parameter to specify the desired format: `html` or `markdown`. **Note:** This endpoint is deprecated. Use… - InsightComments - [Resolve comment thread](https://developers.dovetail.com/reference/post_v1-insights-insight-id-comments-resolve.md): Resolve the comment thread on an insight. This marks the conversation as resolved. > 🚧 Permissions > > Please check you have the relevant permissions required to access this resource. This may… - [Unresolve comment thread](https://developers.dovetail.com/reference/post_v1-insights-insight-id-comments-unresolve.md): Unresolve the comment thread on an insight. This reopens the conversation. > 🚧 Permissions > > Please check you have the relevant permissions required to access this resource. This may include… - [List insight comments](https://developers.dovetail.com/reference/get_v1-insights-insight-id-comments.md): Get a list of page-level and inline comments on an insight. Pass `?include_text_range=true` to include the selected text and surrounding context for inline comments. By default the list returns… - [Create insight comment](https://developers.dovetail.com/reference/post_v1-insights-insight-id-comments.md): Create a comment on an insight. If no page-level comment thread exists on the insight, one will be created automatically unless `thread_id` is set. Pass `thread_id` from list or get comments to… - [Get insight comment](https://developers.dovetail.com/reference/get_v1-insights-insight-id-comments-comment-id.md): Get a comment on an insight by id. > 🚧 Permissions > > Please check you have the relevant permissions required to access this resource. This may include specific permissions on the object itself or… - [Update insight comment](https://developers.dovetail.com/reference/patch_v1-insights-insight-id-comments-comment-id.md): Update a comment on an insight. Only the comment author can update their own comments. > 🚧 Permissions > > Please check you have the relevant permissions required to access this resource. This may… - [Delete insight comment](https://developers.dovetail.com/reference/delete_v1-insights-insight-id-comments-comment-id.md): Delete a comment on an insight. Only the comment author can delete their own comments. Deleted comments can be restored for up to 30 days. Returns the deleted comment. > 🚧 Permissions > > Please… - Contacts - [Get contact](https://developers.dovetail.com/reference/get_v1-contacts-contact-id.md): Retrieve a single contact by its unique identifier. Contacts represent people in your contacts database (e.g. interview participants, customers, or research subjects). Returns the contact's name,… - [List contacts](https://developers.dovetail.com/reference/get_v1-contacts.md): Retrieve all contacts in your workspace's contacts database. Contacts represent people such as interview participants, customers, or research subjects. Results can be filtered by name and sorted by… - [Update contact](https://developers.dovetail.com/reference/patch_v1-contacts-contact-id.md): Update an existing contact's properties. Supports updating the name, email, and custom fields. Only the fields you include in the request body will be modified — omitted fields are left unchanged.… - [Create contact](https://developers.dovetail.com/reference/post_v1-contacts.md): Create a new contact in your workspace's contacts database. Provide a name and email, and optionally attach custom field data (e.g. a Salesforce ID or company name). Contacts can later be linked to… - [Delete contact](https://developers.dovetail.com/reference/delete_v1-contacts-contact-id.md): Delete a contact. Returns the deleted contact object. > 🚧 Permissions > > Please check you have the relevant permissions required to access this resource. This may include specific permissions on… - Notes - [List notes](https://developers.dovetail.com/reference/get_v1-notes.md): Retrieve all data entries (notes) in your workspace. These are documents within a project that capture raw research data such as interview transcripts, survey responses, and session recordings. They… - [Create note](https://developers.dovetail.com/reference/post_v1-notes.md): Create a new data entry (note) within a Dovetail project. Data entries capture raw research data — interview transcripts, survey responses, or session recordings. They must be associated with a… - [Get note](https://developers.dovetail.com/reference/get_v1-notes-note-id.md): Retrieve a single data entry (note) by its unique identifier. Returns the entry's full metadata including title, custom fields, associated project, folder, and attached files. **Note:** The notes… - [Patch note](https://developers.dovetail.com/reference/patch_v1-notes-note-id.md): Update a data entry's (note's) properties. Supports updating the title and custom fields. Only the fields you include in the request body will be modified — omitted fields are left unchanged.… - [Delete note](https://developers.dovetail.com/reference/delete_v1-notes-note-id.md): Delete a note. The note is soft-deleted and moved to the project's trash, but can be restored for up to 30 days before they’re automatically and permanently deleted. Returns the updated note object.… - [Export note](https://developers.dovetail.com/reference/get_v1-notes-note-id-export-type.md): Export the content body of a data entry (note) in either HTML or Markdown format. Use the `type` path parameter to specify the desired format: `html` or `markdown`. **Note:** The notes resource has… - [Import file to note](https://developers.dovetail.com/reference/post_v1-notes-import-file.md): Create a new data entry (note) by importing a file from a publicly accessible URL. The entry must be associated with a project via `project_id`. Supported file types include documents (PDF, DOCX),… - Transcripts - [Add utterance](https://developers.dovetail.com/reference/post_v1-transcripts-data-id-utterance.md): Add a finalised utterance to a data entry's transcript and broadcast it to connected clients. If the entry has no transcript, one is created automatically. Send finalised utterances only. - [Attach audio](https://developers.dovetail.com/reference/post_v1-transcripts-data-id-audio.md): Attach an already-uploaded audio file to the live transcript on a data entry. The transcript node currently being written to via `appendLiveTranscriptUtterance` or `setLiveTranscript` is wrapped in… - [Set transcript from download URL](https://developers.dovetail.com/reference/put_v1-transcripts-data-id.md): Create or replace a data entry's live transcript by fetching a Recall async transcript JSON from `download_url`, mapping participant names to speaker labels, and writing the result in a single… - Users - [Get user](https://developers.dovetail.com/reference/get_v1-users-user-id.md): Retrieve a single workspace member by their unique identifier. Returns the user's profile information including name, email, job title, role (CONTRIBUTOR, MANAGER, or VIEWER), and whether they are a… - [List users](https://developers.dovetail.com/reference/get_v1-users.md): Retrieve all members of your workspace. Returns each user's profile information including name, email, job title, role, and admin status. Results can be filtered by name or email and sorted by… - Workspace - [Get workspace context](https://developers.dovetail.com/reference/get_v1-workspace-context.md): Retrieve the AI context for the workspace: linked insight docs used as source material for workspace-wide AI features. - [Add workspace context doc](https://developers.dovetail.com/reference/post_v1-workspace-context-docs.md): Add an insight to the workspace's AI context. A workspace can have at most 10 context docs. If the insight is already linked, this is a no-op. Requires a workspace administrator. Returns the full…