Skip to content
bkmark.it
Docs menu

API reference

Sharing

Public, read-only links to a bookmark or a collection.

post /v1/share-links

Create a public read-only link to a bookmark or collection.

Key or token with bookmarks:write Returns 201

Body

Body fields
NameTypeDescription
bookmarkIduuid
collectionIduuid
expiresAttimestamp

Example

curl -X POST 'https://api.bkmark.it/v1/share-links' \
  -H "Authorization: Bearer $BKMARK_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"bookmarkId":"0c9d3a52-6f1e-4b8a-9d2f-5e7a1b3c4d6e","collectionId":"0c9d3a52-6f1e-4b8a-9d2f-5e7a1b3c4d6e"}'
Response fields (8)
Response fields
NameTypeDescription
idrequireduuid
tokenrequiredstring
urlrequiredstring
bookmarkIdrequireduuid or null
collectionIdrequireduuid or null
targetNamerequiredstring or null
expiresAtrequiredstring or null
createdAtrequiredstring

get /v1/public/share/{token}

What a share link shows (no account needed).

No credential needed Returns 200

Parameters

Parameters
NameTypeDescription
tokenrequiredstringIn the path. 16–100 characters.

Example

curl 'https://api.bkmark.it/v1/public/share/tLk2…'