Saved searches
A query and filters, kept up to date as you save more.
- get /v1/saved-searches
- post /v1/saved-searches
- patch /v1/saved-searches/{id}
- delete /v1/saved-searches/{id}
- get /v1/saved-searches/{id}/results
get /v1/saved-searches
Saved searches in display order.
Key or token with bookmarks:read Returns 200
Example
curl 'https://api.bkmark.it/v1/saved-searches' \
-H "Authorization: Bearer $BKMARK_TOKEN" Response fields (1)
| Name | Type | Description |
|---|---|---|
datarequired | object[] | |
idrequired | uuid | |
namerequired | string | |
queryrequired | string | |
filtersrequired | object | |
collection | uuid | |
tag | string | 1–50 characters. |
kind | enum | One of link, note. |
source | enum | One of web, extension, slack, email, zapier, api, import, shortcut, share_target. |
unread | boolean | |
archived | boolean | |
ribboned | boolean | |
broken | boolean | |
positionrequired | integer | -9007199254740991–9007199254740991. |
createdByrequired | uuid or null | |
createdAtrequired | string | |
updatedAtrequired | string |
post /v1/saved-searches
Save a search.
Key or token with bookmarks:write Returns 201
Body
| Name | Type | Description |
|---|---|---|
namerequired | string | 1–100 characters. |
query | string | Default "". Up to 500 characters. |
filters | object | Default {}. |
collection | uuid | |
tag | string | 1–50 characters. |
kind | enum | One of link, note. |
source | enum | One of web, extension, slack, email, zapier, api, import, shortcut, share_target. |
unread | boolean | |
archived | boolean | |
ribboned | boolean | |
broken | boolean | |
position | integer | 0–9007199254740991. |
Example
curl -X POST 'https://api.bkmark.it/v1/saved-searches' \
-H "Authorization: Bearer $BKMARK_TOKEN" \
-H 'Content-Type: application/json' \
-d '{"name":"Hybrid search with pgvector"}' Response fields (8)
| Name | Type | Description |
|---|---|---|
idrequired | uuid | |
namerequired | string | |
queryrequired | string | |
filtersrequired | object | |
collection | uuid | |
tag | string | 1–50 characters. |
kind | enum | One of link, note. |
source | enum | One of web, extension, slack, email, zapier, api, import, shortcut, share_target. |
unread | boolean | |
archived | boolean | |
ribboned | boolean | |
broken | boolean | |
positionrequired | integer | -9007199254740991–9007199254740991. |
createdByrequired | uuid or null | |
createdAtrequired | string | |
updatedAtrequired | string |
patch /v1/saved-searches/{id}
Edit a saved search.
Key or token with bookmarks:write Returns 200
Parameters
| Name | Type | Description |
|---|---|---|
idrequired | uuid | In the path. |
Body
| Name | Type | Description |
|---|---|---|
name | string | 1–100 characters. |
query | string | Up to 500 characters. |
filters | object | |
collection | uuid | |
tag | string | 1–50 characters. |
kind | enum | One of link, note. |
source | enum | One of web, extension, slack, email, zapier, api, import, shortcut, share_target. |
unread | boolean | |
archived | boolean | |
ribboned | boolean | |
broken | boolean | |
position | integer | 0–9007199254740991. |
Example
curl -X PATCH 'https://api.bkmark.it/v1/saved-searches/0c9d3a52-6f1e-4b8a-9d2f-5e7a1b3c4d6e' \
-H "Authorization: Bearer $BKMARK_TOKEN" \
-H 'Content-Type: application/json' \
-d '{"name":"Hybrid search with pgvector","query":"text"}' Response fields (8)
| Name | Type | Description |
|---|---|---|
idrequired | uuid | |
namerequired | string | |
queryrequired | string | |
filtersrequired | object | |
collection | uuid | |
tag | string | 1–50 characters. |
kind | enum | One of link, note. |
source | enum | One of web, extension, slack, email, zapier, api, import, shortcut, share_target. |
unread | boolean | |
archived | boolean | |
ribboned | boolean | |
broken | boolean | |
positionrequired | integer | -9007199254740991–9007199254740991. |
createdByrequired | uuid or null | |
createdAtrequired | string | |
updatedAtrequired | string |
delete /v1/saved-searches/{id}
Delete a saved search.
Key or token with bookmarks:write Returns 200
Parameters
| Name | Type | Description |
|---|---|---|
idrequired | uuid | In the path. |
Example
curl -X DELETE 'https://api.bkmark.it/v1/saved-searches/0c9d3a52-6f1e-4b8a-9d2f-5e7a1b3c4d6e' \
-H "Authorization: Bearer $BKMARK_TOKEN" Response fields (1)
| Name | Type | Description |
|---|---|---|
messagerequired | string |
get /v1/saved-searches/{id}/results
Run a saved search in its library (no query text = its filters, newest first).
Key or token with bookmarks:read Returns 200
Parameters
| Name | Type | Description |
|---|---|---|
cursor | string | Up to 300 characters. |
limit | integer | Default 20. 1–50. |
idrequired | uuid | In the path. |
Example
curl 'https://api.bkmark.it/v1/saved-searches/0c9d3a52-6f1e-4b8a-9d2f-5e7a1b3c4d6e/results' \
-H "Authorization: Bearer $BKMARK_TOKEN" Response fields (4)
| Name | Type | Description |
|---|---|---|
resultsrequired | object[] | |
bookmarkrequired | object | |
idrequired | uuid | |
libraryIdrequired | uuid | |
kindrequired | enum | One of link, note. |
urlrequired | string or null | |
canonicalUrlrequired | string or null | |
titlerequired | string or null | |
descriptionrequired | string or null | |
summaryrequired | string or null | |
siteNamerequired | string or null | |
faviconUrlrequired | string or null | |
imageUrlrequired | string or null | |
sourcerequired | enum | One of web, extension, slack, email, zapier, api, import, shortcut, share_target. |
sourceDetailrequired | string or null | |
sourceAuthorrequired | string or null | |
fetchStatusrequired | enum | One of pending, ok, failed, gone. |
readAtrequired | string or null | |
archivedAtrequired | string or null | |
ribbonedAtrequired | string or null | |
deletedAtrequired | string or null | |
lastCheckedAtrequired | string or null | |
createdByrequired | uuid or null | |
createdAtrequired | string | |
updatedAtrequired | string | |
tagsrequired | string[] | |
collectionIdsrequired | uuid[] | |
hasSavedCopyrequired | boolean | |
libraryIdrequired | uuid | |
scorerequired | number | |
matchedInrequired | enum | One of title, url, description, saved_copy, highlight, note, meaning. |
passagerequired | object or null | |
textrequired | string | |
marksrequired | integer[][] | |
nextCursorrequired | string or null | |
moderequired | enum | One of hybrid, keyword. |
tookMsrequired | number |