Skip to content
bkmark.it
Docs menu

API reference

Collections

One level of collections. A bookmark can be in several.

get /v1/collections

Collections in display order.

Key or token with collections:read Returns 200

Example

curl 'https://api.bkmark.it/v1/collections' \
  -H "Authorization: Bearer $BKMARK_TOKEN"
Response fields (1)
Response fields
NameTypeDescription
datarequiredobject[]
idrequireduuid
namerequiredstring
huerequiredinteger or null-9007199254740991–9007199254740991.
positionrequiredinteger-9007199254740991–9007199254740991.
bookmarkCountrequiredinteger-9007199254740991–9007199254740991.
createdAtrequiredstring
updatedAtrequiredstring

post /v1/collections

Create a collection (added last).

Key or token with collections:write Returns 201

Body

Body fields
NameTypeDescription
namerequiredstring1–100 characters.
hueinteger or null0–359.

Example

curl -X POST 'https://api.bkmark.it/v1/collections' \
  -H "Authorization: Bearer $BKMARK_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"name":"Hybrid search with pgvector"}'
Response fields (7)
Response fields
NameTypeDescription
idrequireduuid
namerequiredstring
huerequiredinteger or null-9007199254740991–9007199254740991.
positionrequiredinteger-9007199254740991–9007199254740991.
bookmarkCountrequiredinteger-9007199254740991–9007199254740991.
createdAtrequiredstring
updatedAtrequiredstring

patch /v1/collections/{id}

Rename or recolour a collection.

Key or token with collections:write Returns 200

Parameters

Parameters
NameTypeDescription
idrequireduuidIn the path.

Body

Body fields
NameTypeDescription
namestring1–100 characters.
hueinteger or null0–359.

Example

curl -X PATCH 'https://api.bkmark.it/v1/collections/0c9d3a52-6f1e-4b8a-9d2f-5e7a1b3c4d6e' \
  -H "Authorization: Bearer $BKMARK_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"name":"Hybrid search with pgvector","hue":1}'
Response fields (7)
Response fields
NameTypeDescription
idrequireduuid
namerequiredstring
huerequiredinteger or null-9007199254740991–9007199254740991.
positionrequiredinteger-9007199254740991–9007199254740991.
bookmarkCountrequiredinteger-9007199254740991–9007199254740991.
createdAtrequiredstring
updatedAtrequiredstring

delete /v1/collections/{id}

Delete a collection (its bookmarks stay in the library).

Key or token with collections:write Returns 200

Parameters

Parameters
NameTypeDescription
idrequireduuidIn the path.

Example

curl -X DELETE 'https://api.bkmark.it/v1/collections/0c9d3a52-6f1e-4b8a-9d2f-5e7a1b3c4d6e' \
  -H "Authorization: Bearer $BKMARK_TOKEN"
Response fields (1)
Response fields
NameTypeDescription
messagerequiredstring

post /v1/collections/reorder

Set the display order.

Key or token with collections:write Returns 200

Body

Body fields
NameTypeDescription
idsrequireduuid[]Up to 500 items.

Example

curl -X POST 'https://api.bkmark.it/v1/collections/reorder' \
  -H "Authorization: Bearer $BKMARK_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"ids":["0c9d3a52-6f1e-4b8a-9d2f-5e7a1b3c4d6e"]}'
Response fields (1)
Response fields
NameTypeDescription
datarequiredobject[]
idrequireduuid
namerequiredstring
huerequiredinteger or null-9007199254740991–9007199254740991.
positionrequiredinteger-9007199254740991–9007199254740991.
bookmarkCountrequiredinteger-9007199254740991–9007199254740991.
createdAtrequiredstring
updatedAtrequiredstring

post /v1/collections/{id}/bookmarks

Add bookmarks to a collection.

Key or token with collections:write Returns 200

Parameters

Parameters
NameTypeDescription
idrequireduuidIn the path.

Body

Body fields
NameTypeDescription
bookmarkIdsrequireduuid[]Up to 500 items.

Example

curl -X POST 'https://api.bkmark.it/v1/collections/0c9d3a52-6f1e-4b8a-9d2f-5e7a1b3c4d6e/bookmarks' \
  -H "Authorization: Bearer $BKMARK_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"bookmarkIds":["0c9d3a52-6f1e-4b8a-9d2f-5e7a1b3c4d6e"]}'
Response fields (1)
Response fields
NameTypeDescription
updatedrequiredinteger-9007199254740991–9007199254740991.

delete /v1/collections/{id}/bookmarks/{bookmarkId}

Remove a bookmark from a collection.

Key or token with collections:write Returns 200

Parameters

Parameters
NameTypeDescription
idrequireduuidIn the path.
bookmarkIdrequireduuidIn the path.

Example

curl -X DELETE 'https://api.bkmark.it/v1/collections/0c9d3a52-6f1e-4b8a-9d2f-5e7a1b3c4d6e/bookmarks/0c9d3a52-6f1e-4b8a-9d2f-5e7a1b3c4d6e' \
  -H "Authorization: Bearer $BKMARK_TOKEN"
Response fields (1)
Response fields
NameTypeDescription
messagerequiredstring