get-a-single-list.api.mdx•2.89 kB
---
id: get-a-single-list
title: "Get a single list"
description: "Get list by its id"
sidebar_label: "Get a single list"
hide_title: true
hide_table_of_contents: true
api: eJytVE1v2zAM/SsGTxsgJOnQYYVvPWxFtwErtg47BD4wNhOrtSVVottkhv77QNlN89Vhh538QYp8j++JPVQUSq8da2sghyvirNGBs8Um0xwyXYECxlWAfA5fdeAAhYJAZec1byCf97Ag9OQvO64hnxexUODQY0tMPqSEUNbUIuQ98MYR5BDYa7MCBbTG1jXyS5OumvVm1T7dXXyw69/v6zWzLS+ku+aUIt2vK4gKPD102lMFOfuOFBhsJaEZEhRoYeKQaxA0noKzJlAQBO9mM3nsk/62uKOSsyfN9UC+QsYJKCitYTIsJ9C5RpcoJ6Z3QY6dIGZTIVDgvHXkWQ9NdXVMPj7DPhHYQ3c8NdM1DS5kJkI/KtDlqcSYhCAjM/mXKkPCCZFM14r6LZoOG1AQWvQsNqhoiV3DkD/HooKHjvzmH/rtyTiH5LM0kJHODvhi3wMQo5w+n50fKynxzFjOlrYz1f9TsLTVaalaCgFXp2IHBFOFl/wiDixa4tpWkMOKUlcxbQ5TcWGY9oOjo8yc/OPzfep8Azn0WFWeQohTdHr6eAYKHtFrGXGCPIaHGT3rVDO7kE+n7DeTe/R4T+Qm6BwcmA5ua8rGCpldZlxT9mXMzwYsIsPOKvghkxw67y6E7Viks/BIaZCPSaDGl0/WtygIP/+6TbPTZmnluLAeIJ1NZpPZzj7Y4rm8uT6J//LmOltavw9eyMrNsIFbTB4Yt4dsPsyCNquG0hY4rNm/mOmVNTkwZVrz1DWojTRKYvWjsPO0owIoyMdlVSiobWAJ9f0CA/30TYzye7xI8+JF16R+pYO8V5AvsQn0F5Bvvo/+e5u9hm78iWaT7NN08gUK7mnzslBjERXUhBX5hGAIXpYlOd45dnS/xB5bf199vAUFuG+KAxOk6ich9f2QcWvvycS4RcjyLQBj/ANIcU9P
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 a single list"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/lists/{listId}"}
context={"endpoint"}
>
</MethodEndpoint>
Get list by its id
<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"}]}
>
</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":{"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}},"required":["id","name","icon","parentId"],"title":"List"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>