1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
---
id: get-highlights-of-a-bookmark
title: "Get highlights of a bookmark"
description: "Get highlights of a bookmark"
sidebar_label: "Get highlights of a bookmark"
hide_title: true
hide_table_of_contents: true
api: eJytVU1v2zgQ/SvCnFqAiNyiRQvdXKAf6aXFbhY9BD7Q0thiIpHscJTaFfjfF0NLkZyoTQ89WSYfh2/evBn2UGEoyXg2zkIBH5Gz2uzrxuxrDpnbZTrbOnfbaroFBaz3AYpreDcsBdgoCFh2ZPgIxXUPW9SEtO64huJ6EzcKvCbdIiOFBAhlja2Gogc+eoQCApOxe1CAB936RpYMmqo5HPftj5u3b9zh5+v6wOzKt8LAcIKMDC4riAoIv3eGsIKCqUMFVrcC2k4gBUby85prEFaEwTsbMAiTl6uV/JxLcVVj1pjAIsIkCSgonWW0LCe0940ptZzIb4IcW0jQbW+wZFDgyXkkNqdLZzEnrCbSRyHL2IanY8wSfCRoVBBYE3/Z7QLybN927RZJ9tFWv9ktXeNosVC2a8UFR2wa9wNETBF4T4gWFGybDsUXFe501zAUIzAqYDzwUkjbNY3eSmWlgFGBdYx/BDTLqXcB6ReqlISasVovEIlnXro+N9Bczbl2Q1YD58To/v75bZvJvZ/G2kN8eOXMFpuYdl+tXj125+j/zDrOdq6z1d9zZumqBe2jghZD0PulvQdJpAgTPiWSznPtKihgn2RLzVhAPqoc8n4SPOZnTReQ7sYR0lEDBfS6qghDiLn2Jr97AQruNBkxR8pi2D5JNzqxZvahyHOm40XtNFVIF9p7UAvNPwSQ/ucaswGenZhI4Waz71+RdujJ2QS810nulSwSTCZTAkmzpI8Pjlot/D5/u0piGrtzclxyPjF6cbG6WM0G4KeBzvrr5SL79dfLbOcoUR+xkmlU4F3gVidLDIPyibF/Fr2fbPbkc3FKXtoj9402NnWmVK8fij+1mBS5OOu3eScoqF1gwff9Vgf8j5oYZfl7hyQvz2aqfvJIZYJ8V1DsdBPwNzk8+2cw7vPsV5TH4WyPyWQy3woABbd4PH9l4iYqqFFXSInFCbAuS/Q8O/qoOcVK983x8f0VKNDnBnpgmBR9kVbfnxBX7hZtjPcsWf4LwRj/B3Qvuxk=
sidebar_class_name: "get api-method"
info_path: API/hoarder-api
custom_edit_url: null
hide_send_button: true
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Get highlights of a bookmark"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/bookmarks/{bookmarkId}/highlights"}
context={"endpoint"}
>
</MethodEndpoint>
Get highlights of a bookmark
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BookmarkId"},"required":true,"name":"bookmarkId","in":"path"}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"The list of highlights","content":{"application/json":{"schema":{"type":"object","properties":{"highlights":{"type":"array","items":{"type":"object","properties":{"bookmarkId":{"type":"string"},"startOffset":{"type":"number"},"endOffset":{"type":"number"},"color":{"type":"string","enum":["yellow","red","green","blue"],"default":"yellow"},"text":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"id":{"type":"string"},"userId":{"type":"string"},"createdAt":{"type":"string"}},"required":["bookmarkId","startOffset","endOffset","text","note","id","userId","createdAt"],"title":"Highlight"}}},"required":["highlights"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>
|
