DOdovetail
Highlights

Get highlight

Changed on

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 you have the relevant permissions required to access this resource. This may include specific permissions on the object itself or its parent, or having the correct user role if you're making updates.

Required scope: note:read

get/v1/highlights/{highlight_id}

Request

  • Base URL
    https://dovetail.com/api
  • URL
    https://dovetail.com/api/v1/highlights/{highlight_id}
  • Auth
    HTTP bearer

Path parameters

highlight_idstring required

Unique identifier of the highlight.

Response

200

Changes

  • 8abea327e6b9Revision 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