get-all-lists.api.mdx•2.4 kB
---
id: get-all-lists
title: "Get all lists"
description: "Get all lists"
sidebar_label: "Get all lists"
hide_title: true
hide_table_of_contents: true
api: eJyNVE1v2zAM/SsGz0Kc7ehbDlvRbcAKLMMOQQ6MzdRqZEmV6G6Gof8+UHY+G2A7WRYfP98TR2go1kF71s5CBQ/EBRpTGB05ggLG5wjVBr7l/62CSHUfNA9QbUbYEQYKq55bqDbbtFUQKHpnI0WoRvi4XMrnOsP33QvVXPzW3J4zFQ0yLkBB7SyTZXFD742uUdzKlyi+I8S6pQ7lxIMnqMDlaKDAB+cpsJ4yT+WfYRgCDqBAM3Xx3+66ucBEDto+Q1JgsaO7hqsOb+0KbG8M7gxBxaGnpEDX94BJgcdAlh/vpL8TZQK8B5LtO+GsQ9ujAQWxw8BCXkN77A1DdbQlBa89heG/8vl+Z3R9Ad05ZwgtpCTEv/Y6UCOJdQPzsOZWLxo7hdkqYM0SPosL0m2UicNtStnSEbeugQqeKfOFojkojzqNFN4oxKzKPhioYMSmCRRjKtHr8u0DKHjDoKWjzPFsngR6HEvL7GNVlhyGxQEDHoj8Ar2HG45h3VIxRyjcvuCWiq8zvphqkYYu3ssPUe6U+fLVnGYpmaWPDJPZZhCo+fDZhQ6lwi+/1nne2u6duEvXU0kfFsvFEs5TPdWzenq8W//q6bHYu3BdvDQrXLvIHWaRTqp/txluNH96uO9XyNQg0x8uvUFtJX7maJxpPHGtoHWR5WIcdxjpZzApyfUs0s32TGLeOApawoZC5v1AA1SwqmvynNk2fX77t3tEaDnJ6eHTGhTgNRk3w8/Rj5vEDhexx3FCrN2BbEqg5iJY/iGJeP8CO0jVRg==
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 all lists"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/lists"}
context={"endpoint"}
>
</MethodEndpoint>
Get all lists
<ParamsDetails
parameters={undefined}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Object with all lists data.","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"]}}}}}}
>
</StatusCodes>