Get highlights of a bookmark

GET 
https://try.karakeep.app/api/v1/bookmarks/:bookmarkId/highlights

Get highlights of a bookmark

Request

Path Parameters

bookmarkId BookmarkIdrequired

Responses

200

The list of highlights

application/json

Schema

Schema

highlights object[]required
Array [
bookmarkIdstringrequired
startOffsetnumberrequired
endOffsetnumberrequired
colorstring
Possible values: [yellow, red, green, blue]
Default value: yellow
textstringnullablerequired
notestringnullablerequired
idstringrequired
userIdstringrequired
createdAtstringrequired
]

Example (auto)

{
  "highlights": [
    {
      "bookmarkId": "string",
      "startOffset": 0,
      "endOffset": 0,
      "color": "yellow",
      "text": "string",
      "note": "string",
      "id": "string",
      "userId": "string",
      "createdAt": "string"
    }
  ]
}

404

Bookmark not found

application/json

Schema

Schema

codestringrequired
messagestringrequired

Example (auto)

{
  "code": "string",
  "message": "string"
}

Authorization: http

name: bearerAuthtype: httpscheme: bearerbearerFormat: JWT

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://try.karakeep.app/api/v1/bookmarks/:bookmarkId/highlights");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://try.karakeep.app/api/v1

Auth

Bearer Token

Parameters

bookmarkId — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!