diff options
| author | Mohamed Bassem <me@mbassem.com> | 2026-01-01 10:58:22 +0000 |
|---|---|---|
| committer | Mohamed Bassem <me@mbassem.com> | 2026-01-01 10:58:22 +0000 |
| commit | 4b54eeec0ebdd60d28ce865d56e079c4d11384ae (patch) | |
| tree | 8180003c92358d74a9796b48d3fd341fae8f8338 /docs/versioned_docs/version-v0.30.0/api/get-bookmarks-in-the-list.api.mdx | |
| parent | d472a3a1c428bad8ce2ddc0822fb5b327e9465d4 (diff) | |
| download | karakeep-4b54eeec0ebdd60d28ce865d56e079c4d11384ae.tar.zst | |
release(docs): release the 0.30 docs
Diffstat (limited to 'docs/versioned_docs/version-v0.30.0/api/get-bookmarks-in-the-list.api.mdx')
| -rw-r--r-- | docs/versioned_docs/version-v0.30.0/api/get-bookmarks-in-the-list.api.mdx | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.30.0/api/get-bookmarks-in-the-list.api.mdx b/docs/versioned_docs/version-v0.30.0/api/get-bookmarks-in-the-list.api.mdx new file mode 100644 index 00000000..950c7c4b --- /dev/null +++ b/docs/versioned_docs/version-v0.30.0/api/get-bookmarks-in-the-list.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-bookmarks-in-the-list +title: "Get bookmarks in the list" +description: "Get bookmarks in the list" +sidebar_label: "Get bookmarks in the list" +hide_title: true +hide_table_of_contents: true +api: eJzNWN1v2zYQ/1cEvmwDhDgdOqzQW1psXfbRBmuKPQR+OEsnizVFquTJiWvofx+OlCXZkR25DbA9xRHv83fHu+NtRYYutbIiabRIxFukaGHMqgS7cpHUERUYKelIxIJg6URyJ/6UjpyYx8JhWltJG5HcbcUCwaK9qqkQyd28mceiAgslElrnCVxaYAki2QraVCgS4chKvRSxwAcoK8WfJMpMPWyW5f2nVz+bhy8/FQ9EJn3F2iV5EtZ+nYkmFhY/19JiJhKyNcZCQ8kEKhDEQrJDFVAhmvikel2X7Be4VMQeD3YuwxxqRSIJX/b05aBcr9AZS+9thnan83ONdjOuVNflAu0paUqWkiZI6szfAfOmts6cFJ0GiqdlL4xRCFoMUAgQ7yfLdR45pIhM5E+7xPnORanRhJqie6lUtMBI6lTVGWa7lLLoKqMdXkTvDGEcUSF7phQ08yiwS4xyYyNnSuzT8mLUx/+JaR3Yrdg3gfEA9Dk7ENQ4xv3Hy0v+s+/D+8UnTNlOKvwVjDIgYA2tMcwBVaVkCswx++SYbSScxgsSsaisqdCSDEo7qwekYC1s2FjC0j0tQmaPM7KJRWoRCLMrGj0tTSZzOX4cC10rBQvOaI5c0+X3BEqwaSHXmI1kchOLHNaGy9Wxc4LlUurlBwKq3dP6+rrh6jRF5wSrkKq2yDChzphr3sTC1WUJVn7xUXp+8drQNHiCHZtptKa26QSxg+pZSRGLe1xwgir+XZqFVOjrO6F2nNSxcFIvFebhwHq3ZFkZS96X2qG9Hs+p0H2eOVHDXR05ACJIC8xej8LV+cxuFnUJWsybvaJ0xxpb+XvSPN3gAhuN73PfH087EE6Pm6KkXgUIrRrHb/I12qtCE+hlCUv8OKb2GPGVc0hjcR7LxNQialcYOoeryvJzyPNaqRs2LFSQszRZTC3cK8y+gnktMzRnGQprmU6MS0GletNn2pP0bVaeY87O84kKmPr5CyDUVBg7LVj1QklX4DTqDAhvWo5peDDHX217m8BwUDI8dbjBc57Lvq0iED6Eoup/jJWEUOSn3dxxU3c6vtVW4JwLweRft0+Q+yIi/C3vmY70DW4170bL/NG2N7WWOfllKLad7Y/frK+GuQel9/UZUK/1Spv7kd7lGeZNB+3zN95JYeae9tugiA2bQRv9VtKH4fcFaI32us2Rg9Iu2qLLdO386wueGKnkIgwkHytlIEPu57AGAg5xD91ZGTY2I/RQzJtRgn6a3pudB/Pu3nB7OMmOD6DdrNVOVn2SdjGf92/L1y1Ugg3U+EDtY/Nsj/s3x56cgaobWErN/r7uSBuPy8vLl4/fSLwNiLShKDe1zp7vbZSabHwwLNE5TqzHZweeegk9Pce28fxUmEwkYhlyjtcTiZjx+87NtmF30cyGMDm0690OxQ93YgtZZtG5ZgaVnK1fcE6DlYy6N749DmjtthgFUeWS2Yzs5mIFFlaI1QVUlTh8Ot8WGLUSIpP7J/EfLX0UbOGADNY/HxjT9kk5WAJ1ALFmf3eZjN9cnogvoP/xq7ElsIW//3PrUZQ6N8zOXgeTXlxcXlwOVh2dPVc316P2X91c+9f5nvHsLM8AxhFP7Ml291Q/tfQ6GIa79Dq9KQuOc3ecVQqkf1+2g3mI+J1fU3F4k25f1Qd9HovCOGKy7XYBjjtS0/DnsD/gVMik44D3C5AVbg6WUWtQNdvhlzxH6Hfrpim03f7oNPFRyP7DpcxoRIJXjxY1vXfz/mKNY37U1e//bkvBD9Ex7bt+qjdDnX1cwpqTG0yBwAFlC8LhVZpiNTT1Ualj07tS8/aXWxHG5OHmY/8WDp+g+yZtt4Hi1qxQN01nIfH/bGDT/Au5qa9K +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 bookmarks in the list"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/lists/{listId}/bookmarks"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Get bookmarks in the list + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"ListId"},"required":true,"name":"listId","in":"path"},{"schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"required":false,"name":"sortOrder","in":"query"},{"schema":{"type":"number"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"boolean","default":true,"description":"If set to true, bookmark's content will be included in the response. Note, this content can be large for some bookmarks."},"required":false,"description":"If set to true, bookmark's content will be included in the response. Note, this content can be large for some bookmarks.","name":"includeContent","in":"query"}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"Object with list data.","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"modifiedAt":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"archived":{"type":"boolean"},"favourited":{"type":"boolean"},"taggingStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"summarizationStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"source":{"type":"string","nullable":true,"enum":["api","web","cli","mobile","extension","singlefile","rss","import"]},"userId":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"pdfAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"contentAssetId":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"crawlStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["linkHtmlContent","screenshot","pdf","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","avatar","unknown"]},"fileName":{"type":"string","nullable":true}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","userId","tags","content","assets"],"title":"Bookmark"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}} +> + +</StatusCodes> + + +
\ No newline at end of file |
