Search

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, or provide structured filter objects to narrow results by specific entity types and their attributes. To include a content type with no filter constraints, pass an empty array for that type (e.g. "notes": []). Types omitted from the filter are excluded from results. The notes key in the filter and response corresponds to the "data" resource in the Dovetail product.

Results are paginated using offset and limit (default 50, max 250). Each content type is returned in its own array within the response.

📘 Prefer Search V2

For more advanced filtering including location-based search, contributor filters, and additional content types (projects, folders, people, dashboards, agents), use the Search V2 (POST /v2/search) endpoint.

Required scope: search:read

post/v1/search

Request

  • Base URL
    https://dovetail.com/api
  • URL
    https://dovetail.com/api/v1/search
  • Auth
    HTTP bearer

Request body

offsetinteger

An optional offset - will default to 0 if not provided.

limitinteger

A limit of search item results (highlights, notes, insights, channels and/or themes), if not provided it will be defaulted to 50 with a maximum of 250 search items per request.

querystring

An optional query to search the highlights, notes, insights, channels and/or themes.

Response

200

Changes

    • breaking

      added subschema #1 subschema #2 to the / response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status