List and search bookmarks

List bookmarks owned by the authenticated account. Filter by free-text query (q), tag, or collection_id.

GET/v1/bookmarks

Authorization

AuthorizationBearer token (JWT) · headerrequired

Bearer API key issued for your account. Send Authorization: Bearer <key>.

Query parameters

qstring

Free-text search across title, description, and archived content

tagstring

Match a tag case-insensitively

collection_idstring

Filter to bookmarks in this collection

Responses

200

List of bookmarks

Array of Bookmark

idstringrequired

urlstring<uri>required

titlestringrequired

descriptionstringrequired

tagsstring[]required

collection_idstring | null

ownerstringrequired

archived_contentstringrequired

Markdown archived from the URL at creation time

archived_atstring<date-time> | null

created_atstring<date-time>required

updated_atstring<date-time>required

401

Missing or invalid bearer token

string

403

Billing or plan entitlement blocked the request

string

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

qqueryFree-text search across title, description, and archived contenttagqueryMatch a tag case-insensitivelycollection_idqueryFilter to bookmarks in this collection

Request

curl -X GET 'https://api.webfold.ai/v1/bookmarks' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

import requests

response = requests.get(
    "https://api.webfold.ai/v1/bookmarks",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

const response = await fetch("https://api.webfold.ai/v1/bookmarks", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

Response

[
  {
    "id": "bkm_1",
    "url": "https://example.com",
    "title": "Example",
    "description": "An example page",
    "tags": [
      "demo"
    ],
    "collection_id": "col_1",
    "owner": "dev",
    "archived_content": "string",
    "archived_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]

"string"

"string"