Sharing
Public, read-only links to a bookmark or a collection.
get /v1/share-links
Active share links in the library.
Key or token with bookmarks:read Returns 200
Example
curl 'https://api.bkmark.it/v1/share-links' \
-H "Authorization: Bearer $BKMARK_TOKEN" Response fields (1)
| Name | Type | Description |
|---|---|---|
datarequired | object[] | |
idrequired | uuid | |
tokenrequired | string | |
urlrequired | string | |
bookmarkIdrequired | uuid or null | |
collectionIdrequired | uuid or null | |
targetNamerequired | string or null | |
expiresAtrequired | string or null | |
createdAtrequired | string |
post /v1/share-links
Create a public read-only link to a bookmark or collection.
Key or token with bookmarks:write Returns 201
Body
| Name | Type | Description |
|---|---|---|
bookmarkId | uuid | |
collectionId | uuid | |
expiresAt | timestamp |
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)
| Name | Type | Description |
|---|---|---|
idrequired | uuid | |
tokenrequired | string | |
urlrequired | string | |
bookmarkIdrequired | uuid or null | |
collectionIdrequired | uuid or null | |
targetNamerequired | string or null | |
expiresAtrequired | string or null | |
createdAtrequired | string |
delete /v1/share-links/{id}
Revoke a share link.
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/share-links/0c9d3a52-6f1e-4b8a-9d2f-5e7a1b3c4d6e' \
-H "Authorization: Bearer $BKMARK_TOKEN" Response fields (1)
| Name | Type | Description |
|---|---|---|
messagerequired | string |
get /v1/public/share/{token}
What a share link shows (no account needed).
No credential needed Returns 200
Parameters
| Name | Type | Description |
|---|---|---|
tokenrequired | string | In the path. 16–100 characters. |
Example
curl 'https://api.bkmark.it/v1/public/share/tLk2…'