COcodeverdotdev
personal-bookmarks

GET /personal/users/{userId}/bookmarks

Returns list of user's bookmarks - might be filtered by query text (q with limit) > location > orderBy parameters; The parameters precedence is shown via **>** pageandlimit` query parameters are used for pagination - if missing default values are used.

Request

  • Base URL
    http://localhost:3000/api
  • Auth
    HTTP bearer

Path parameters

userIdstring required

keycloak user id

Query parameters

qstring

search query (terms are separated by space). There are special filters available:

  • lang:iso_language_code - e.g. lang:en for English, lang:es for Spanish and lang:de for German bookmarks
  • site:site_URL - e.g. site:codepedia.org bookmarks only from website www.codepedia.org
  • userId:UUID-user - to be used only when querying public bookmarks submitted by the user with userId
  • private:only - makes sense only when used for querying personal bookmarks
pageinteger

Pagination query param - it is used to skip results in combination with limit query param Defaults to 1 and in this case no results are skipped

limitinteger

Limits the number of returned results (used in combination with queryParam)

locationstring

location of the bookmark, usually an URL

orderBy'MOST_LIKES' | 'LAST_CREATED' | 'MOST_USED'

It is considered in the abscence of q or location parameters Possible values:

  • MOST_LIKES - personal bookmarks most liked by the community
  • LAST_CREATED - personal bookmarks last added
  • MOST_USED - personal bookmarks the user (owner) clicked the most

Response

List of bookmarks

_idstring
namestring required
locationstring required
languagestring required
tagsstring[] required

Writes require at least one tag and at most 13 unique tags after trimming, lowercasing and deduplication in first-seen order. Empty/non-string values and tags starting with "awesome" are rejected. AI recommends at most 8 relevant tags where possible. No raw maxItems/uniqueItems constraint is applied because duplicate inputs are accepted and legacy reads are unchanged.

descriptionstring
descriptionHtmlstring
updatedAtstring date-time
createdAtstring date-time
lastAccessedAtstring date-time
publishedOnstring date
publicboolean
userIdstring required
likeCountnumber
sourceCodeURLstring
ownerVisitCountnumber
youtubeVideoIdstring
stackoverflowQuestionIdstring

Changes

No recorded changes to this operation across all 7 revisions of this API.