get-bookmarks-in-the-list.api.mdx•6.97 kB
---
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: eJzNWN9v4zYM/lcMvWwDjKY33LCD39piu3U/rsW1wx6KPDA2E6uRJZ9Ep00D/+8DJcd2Uid17wpsT00tUvz4iaRIbUSGLrWyJGm0SMRHpGhmzLIAu3SR1BHlGCnpSMSCYOFEcif+lI6cmMbCYVpZSWuR3G3EDMGiPasoF8ndtJ7GogQLBRJa5wVcmmMBItkIWpcoEuHISr0QscBHKErFnyTKTD2uF8XD/YefzePTT/kjkUk/sHVJXoStX2aijoXFL5W0mImEbIWx0FCwgAoCsZDsUAmUizo+al5XBfsFLhWx54Ody3AOlSKRhC879uagXGfQGUtXNkO7tfmlQrseNqqrYob22G5KFpJG7NTC3xJzUVlnjm6dBomX954ZoxC06LEQKN4Nlst55JAiMpFfbQPnOxelRhNqih6kUtEMI6lTVWWYbUPKoiuNdngSfTKEcUS57JRS0KyjwC4wmhsbOVNgF5Yngz7+T6C1ZDfbXgTFPdKn7EAw45j3H09P+c+uD1eze0wZJ+U+BaMMCNhCA4Y1oCyVTIE1JveO1QaO0/iNRCxKa0q0JIPRFnVPFKyFNYMlLNzLW8jseUTWsUgtAmF2RoOrhcnkXA4vx0JXSsGMI5pPrm7je4Qk2DSXK8wGIrmOxRxWhsvVoXWCxULqxQ0BVe5le13dcFWaonOCTUhVWWSaUGesNa1j4aqiACuf/Cm9/fba0Dh6Ao71ONJ9rX/jsAiZMbAARJDmmJ0PgmvrsxSxyKsCtJjWOyXgji02++/s5uV66WI0Xs39bXTcgbB6GIqSeunJr6wa9Gh80O7k/Ah5WcAC/x4ye0j4zDnkG3FUjKQWUbvc0Gu05pVS12wpJOBrVEuLqYUHhdlXKK9khuZVQGEl05FE51Soiy50XpRvwuw1cLaejzMAFeXGjmO1minpchwnnQHhdaMxDjhr/NWU8REKe8nqpUPuTLn/+LZcJHwkn4v+x1AyOlPZdGTODEPd2vhWrMDB4cH6X7cviPv0ZSPZvFMaii0Obanw02CBHUrzVzASCyef+ts2PezhFPhqmjtSOl/fgPVKL7V5GLg1vMK0bql9+ytv1DHzbfJbr9r0y/CWiZv+lxlojfayiY696iuaushyTYfna5IYKLachYfI8Vdqh39aDwp0rd5OY9drxnY6r/02a7g7avqPLqDa85l2885545xgXBofqRmAXh18XR+8s0/P1DUspGY3z1vR2tPx/vT9876dJ9RIG4rmptLZ2/XrqcmG26cCneNQeL6256nfoZPnI629PuUmE4lYhCjhkTkRE5453GQT5ul60qfJoV1t53rfAokNZJlF5+oJlHKyesdRCFYy6x58sxzY2k7WOVHpksmE7PpkCRaWiOUJlKXYH+duc4yaHSIz92PaH418FLDwgfSeJG6Y02bM6T1MtASxZZ9nLMZzgBfilPE/fjW2AEb4+z+3nkWp54bV2esA6d3J6clpb/xu8ZxdXw7iP7u+9BPjDnh2lu9r44j72mSzHR+PPcTstYxteB1/vQmO8002KRVIP/M07Ws48Tv/dMLHm7RvKN2hT2ORG0csttnMwPHtUdf8Ocy0HAqZdHzg3VC+xPXeA8kKVMU4/MPDAfntE8gY2fZN47jwQcr+w4eCwRMJXj17POi8m3aJNcz5QVe//9yUgh+iQ9a3d59e92125xKe3vi+zBH4QBlBWDxLUyz7UJ+VOobelpqPv9yK0NL2p/HdLOwParuQNpsgcWuWqOu6RUj8PwOs638Bja0zuw==
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},"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},"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},"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","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","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>