Sign in
Lists

Create a new list

Changed on

Create a new bookmark list. Lists can be manual (bookmarks are added explicitly) or smart (bookmarks are matched automatically by a search query).

post/lists

Request

  • Base URL: https://try.karakeep.app/api/v1
  • URL: https://try.karakeep.app/api/v1/lists
  • Auth: HTTP bearer

Request body

namestring required
descriptionstring
iconstring required
type'manual' | 'smart'
querystring
parentIdstring nullable

Response

The created list.

idstring required
namestring required
descriptionstring nullable
iconstring required
parentIdstring nullable required
type'manual' | 'smart'
querystring nullable
publicboolean required
hasCollaboratorsboolean required
userRole'owner' | 'editor' | 'viewer' | 'public' required

Changes

  • 6210da080616Revision changes
    • info

      api operation id createList was added

    • info

      added the non-success response with the status

  • dc0636c164c7Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status