get-a-bookmarks-in-a-list.api.mdx•6.12 kB
---
id: get-a-bookmarks-in-a-list
title: "Get a bookmarks in a list"
description: "Get the bookmarks in a list"
sidebar_label: "Get a bookmarks in a list"
hide_title: true
hide_table_of_contents: true
api: eJytV99v20YM/lcEPm2AEKdDhxV6c4qty7CtwZphD4YeaIm2Lpbu1DvKsWvofy94kiXZkRtlzVMc3Ufy46878gApucSqkpXREMEH4oAzCpbGbAq0GxcoHWCQK8cQAuPaQbSAP5VjB3EIjpLKKt5DtDjAktCSnVecQbSI6ziEEi0WxGSdB7gkowIhOgDvS4IIHFul1xAC7bAoc/mkSKX5br8uHh/e/WJ2X37OdswmeSfWFXuIWL9NoQ7B0udKWUohYltRCBoLAeQNIAQlLpXIGdThiHldFUuyp4pWmLuhpkLxUdHniux+XFPnyJHj+8o6803VSYM41R0L3pVGO3Ki/qfra/lzmqOPywdKOHhUnPnEBCkyXkEIidFMmkUCyzJXCYrE7MGJ2Ahr4xVBCKU1JVlWjdEu9wMoWot7IctUuOdVqPRpcOoQEkvIlM559LQwqVqp8eMQdJXnuJTgSq7rLtQTkGiTTG1pyGlpTE6oxewKt0aK+NI543qt9PoTI1fueXshkK4K6RJXJQk5B2JC5ZUlCRPpVKTiOgRteBp/VxUF2v20qPgWfeW8NSU7coDMmGSU3oySOwYCFYSQVQVqiOuTlliIxVb/iTaPG9Sz0fRx5S+RbzvQnF6mkiu98cGvbD7q0fSqOmnKCXhV4Jr+HTN7CTx3juQim1QjiSXSLjP8EqlVled3YqnpkJeIlpYSi485pf9DeKtSMi8iiluVTAx0xkX+vi+dZ/FHN6ahseLM2Gkhqpa5chlNQ6fIdNdKTAuKSPzVXpoTBM46z6ObRojlUfu+xmLasW8s/2Oss5ypbDKxAcapHm18L1eUwvNk/a/7Z+C+F8VIuuqFxupW6lTl9PfobTnWsy+ISAhOfRmqbYeXsXqeXPvjYe6D0vv6ClGv9Eabx5EnwAvEdRfa13+/JqW5v0GPfn8aflmi1mRv21o4uzihvdIE105P/naDkXtSeu5SKPxr2LON61FAP0adDE2DQedkqjkfYdohoS+ULu5xP8DetG6AMNC043aifXFR9dPkiZ6BqTtcKy0O3XTQ2jv+9vrt0+lXpv9AGw5WptLp6029iUnHZ5yCnJOkPz0789Rr6PGSvNrLc2ZSiGDd1IOsIxHMZHJ3s0Ozq9SzYZgc2e1xZ/JzChwwTS05V8+wVLPtG6k3tEqi7sm3x020VljlDBFkzKWLZjO2+6vMoE3JXmFZwtnoAvcZBa2CwKz8+tfCg4aJpGOw7H2SiLarwmDl68IjdsULD5NZ2oOkNfyP34wtUPj98d+9j6HSKyPi4nPD6M3V9dX1YJv6vaUzv7sdZT+/uw1WxnrqR6x4Km+wcSyDZ3Q4Ll6y4uKFBfdsputK67m9uHFc3qdZmaPye0M7YTb5XvilVJIbddtpn/I4hMw4FtjhsEQnb0Jdy+dmL5RCSJWTdPd75Ib2gw11i3klHPx+egHbrZw9OO4LadzKxYj88E9b+j8GlyJwvMP1fmizZ96s8XLvZ4SpjEmLQ3s4TxIqh349aW2h3rXWh1/voRnNhjvcad0Nt4dTSodDg7g3G9J13TFk+V8I1vVX803oZQ==
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 a bookmarks in a list"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/lists/{listId}/bookmarks"}
context={"endpoint"}
>
</MethodEndpoint>
Get the bookmarks in a 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":"number"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","title":"Cursor"},"required":false,"name":"cursor","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"]},"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},"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":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","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>