Skip to main content
GET
/
v1
/
highlights
List highlights
curl --request GET \
  --url https://dovetail.com/api/v1/highlights \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "note_id": "<string>",
      "tags": [
        {
          "id": "<string>",
          "title": "<string>"
        }
      ],
      "text": "<string>",
      "type": "highlight",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "page": {
    "total_count": 123,
    "has_more": true,
    "next_cursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
object

See Pagination for details about how to use a cursor to iterate through the list.

​
sort
default:created_at:desc

See Sort for details on the sort parameter.

Available options:
created_at:asc,
created_at:desc
​
filter
object

You may only use one of project_id, tag_id or highlight_id as a filter parameter. See Filters for details on parameter formatting.

Response

200

​
data
object[]
required
​
page
object
required