aboutsummaryrefslogtreecommitdiffstats
path: root/docs/versioned_docs/version-v0.28.0/api/get-lists-of-a-bookmark.api.mdx
blob: 1b7134a99c02c98672b16b88c509eaa86efc36ad (plain) (blame)
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
---
id: get-lists-of-a-bookmark
title: "Get lists of a bookmark"
description: "Get lists of a bookmark"
sidebar_label: "Get lists of a bookmark"
hide_title: true
hide_table_of_contents: true
api: eJytVE2P1DAM/SuVTyBF2wEtAvW2SIAWOCBYxGE0B0/rmWanTbKJu8xQ5b8jp52v3bJw4NSPPMfPz8/uoaJQeu1YWwMFfCDOGh04ZHaVYba0dtOi34ACxnWAYg5vx18BFgoClZ3XvINi3sOS0JO/6riGYr6ICwUOPbbE5EMChLKmFqHogXeOoIDAXps1KKAttq6RX5p01Wx36/bn7ZvXdvvrVb1ltuUbYaA5QfYMriuICjzdddpTBQX7jhQYbAW0PIIUaCnNIdcgrDwFZ02gIExezmbyOFfhpqakgohQ63Xd6HXNARSU1jAZlgh0rtElSkR+GyRsokC7vKWSQYHz1pFnPSRNCp/A0HvcCU+mNvw9XFePNYz7yicOzop7LL7pmgaXIq0oGBXocgoYUz/J8PVE+olbBsBEr03XipFaNB02oCC06FncVNEKu4ah2J9FBXcd+d0/5XPdstHlCXRpbUNoIJ65ZC7yjWKNpZ4UdrhmcfTbZx0Y4sNbhh4uYjq4nF0+dtHep5mxnK1sZ6r/56DSVtO9bikEXE+dPeCfbjjiUyEpnmtbQQFrSlllaArI9+MU8v44WTEfRJA94O/3U975Bgrosao8hRBzdDq/fwEK7tFr6VgqYDweVNu3vWZ2ochz9ruLDXrcELkLdA7UxICON8iMck3ZpxGfDVykYScL6pvoOmQ+XVMHkSSz1JFg4p0EAjW+vLe+RWH48cdNUlKblZVwqXqg9OJidjE72VIHPldfrif5X325zlbWn5OXYsXLNnCLyRHjPvvzYn4w3QeDPbXLh6KZtpy7BrWRnKlv/djx+WGBSnuLs206Ol9BbQMLtO+XGOi7b2KU3+PIzhfHlidjVDrIewXFCptATzB/9nU06vPsT2z3m9PskrOaTr5AwYZ259s/LqKCmrAin1gMgKuyJMcnoY+GUdxzGIYP725AAZ575oFH0u2TtPp+QNzYDZkYDyxZvoVgjL8BtGuT5g==
sidebar_class_name: "get api-method"
info_path: api/karakeep-api
custom_edit_url: null
---

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 lists of a bookmark"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/bookmarks/{bookmarkId}/lists"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Get lists 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":{"lists":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true},"public":{"type":"boolean"}},"required":["id","name","icon","parentId","public"],"title":"List"}}},"required":["lists"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
  
</StatusCodes>