Skip to main content

list_bookmarks

Return a paginated list of bookmarks.

def list_bookmarks(
page: integer = 1,
per_page: integer = 25,
status: string = None
) - > object

Returns a paginated list of bookmarks, optionally filtered by status.

Parameters

NameTypeDescription
pageinteger = 1The page number for pagination, starting from 1.
per_pageinteger = 25The number of items to return per page, with a maximum of 100.
statusstring = NoneFilters the bookmarks by their status. Valid options are 'active', 'archived', or 'trashed'.

Returns

TypeDescription
objectA JSON object containing a list of bookmarks and the total count.