get-all-lists.api.mdx•2.34 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: eJyNVMtu2zAQ/BVhzoTl9qibD22QtkAD1EUPhg9raR0xliiGXKUVBP57QUp+xkB7EsV9ze7MckTFvnTaiu4MCjywZNQ0WaO9eCgIPXsUG3xL/1sFz2XvtAwoNiN2TI7dqpcaxWYbtgqOve2MZ49ixMflMn6uK3zfvXAp2W8t9blSVpHQAgplZ4SNxDCyttElxbD8xcfYEb6suaV4ksEyCnQpGxSs6yw70VPlCf7ZjZyjAQpauPX/DtfVhY8Xp80zgoKhlu8arjq8tSuYvmlo1zAKcT0HBV3ecwwKlhwbebxT/k6WyeG9I5u+jZy1ZHpqoOBbchLJq3hPfSMojrag8NqzG/6jXojkvvbacRWT6wrzQOZ2LsBvFURLjEy6QbgNnujZhpAsLUvdVSjwzIkKinJCfpSgZ/fGzifB9a5BgZGqyrH3ISer87cPUHgjpyPYRN9snrR37LgWsb7Ic3HD4kCODsx2Qdbihj6sa87mDFm3z6Tm7Ovsn01YYkMXq/AjinKqfLkQp4nGyrGP5IZidoKaD58711JE+OXXGnEe2uy7GB67niB9WCwXS5ynesKzenq8i3/19JjtO3cNPjYbNdZ5aSnpbxL0u6W/kfNpJ9+/DlODwn8ktw1pE/MnjsaZxhPXCnXnJV6M4448/3RNCPF61t9meyYxPSYKNVPFLvF+4AEFVmXJVhLbTZ/W+vaJiLSc5PTwaQ0FuibjZvgp+/GRMMNF7nGcPNbdgU0IUDMIif8IUbx/AXt7yNI=
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}},"required":["id","name","icon","parentId"],"title":"List"}}},"required":["lists"]}}}}}}
>
</StatusCodes>